update docs for the unique functionality

Signed-off-by: Grant Ramsay <seapagan@gmail.com>

Author: seapagan

CONTRIBUTING.md

@@ -5,7 +5,7 @@ Thank you for your interest in contributing to SQLiter! We welcome
 all contributions, big or small.
 
 If you are not sure where to start, please take a look at the [open
-issues](https://github.com/seapagan/sqliter/issues). If you have an
+issues](https://github.com/seapagan/sqliter-py/issues). If you have an
 idea for a new feature or would like to report a bug, please open a new issue.
 
 We also welcome contributions to the documentation. If you find any errors or
@@ -34,8 +34,8 @@ If you already have a Python version installed, uv will use this.
 
 Before you start contributing, please make sure you have read and understood our
 [Code of
-Conduct](https://github.com/seapagan/sqliter/blob/main/CODE_OF_CONDUCT.md) and
-[License](https://github.com/seapagan/sqliter/blob/main/LICENSE).
+Conduct](https://github.com/seapagan/sqliter-py/blob/main/CODE_OF_CONDUCT.md) and
+[License](https://github.com/seapagan/sqliter-py/blob/main/LICENSE).
 
 To get started, follow these steps:
 
@@ -182,14 +182,14 @@ Here are some guidelines to follow when contributing to SQLiter:
 - Make sure your code passes all tests before submitting a pull request.
 - Document your code using
   [docstrings](https://www.python.org/dev/peps/pep-0257/).
-- Use [GitHub issues](https://github.com/seapagan/sqliter/issues)
+- Use [GitHub issues](https://github.com/seapagan/sqliter-py/issues)
   to report bugs or suggest new features.
 
 ## Contact
 
 If you have any questions or need help with contributing, please contact me
 **@seapagan** on GitHub. You can also use the [GitHub
-Discussions](https://github.com/seapagan/sqliter/discussions)
+Discussions](https://github.com/seapagan/sqliter-py/discussions)
 feature.
 
 Happy contributing!

README.md

@@ -49,6 +49,7 @@ Website](https://sqliter.grantramsay.dev)
 - Table creation based on Pydantic models
 - Automatic primary key generation
 - User defined indexes on any field
+- Set any field as UNIQUE
 - CRUD operations (Create, Read, Update, Delete)
 - Chained Query building with filtering, ordering, and pagination
 - Transaction support

docs/guide/data-ops.md

@@ -23,8 +23,8 @@ print(f"Name: {result.name}, Age: {result.age}, Email: {result.email}")
 > [!IMPORTANT]
 >
 > The `insert()` method will raise a `RecordInsertionError` if you try to insert
-> a record with a primary key that already exists in the table. Also, if the
-> table does not exist, a `RecordInsertionError` will be raised.
+> a record with a primary key that already exists in the table or if the table
+> does not exist.
 
 ## Querying Records
 
@@ -64,6 +64,16 @@ user.age = 26
 db.update(user)
 ```
 
+> [!IMPORTANT]
+>
+> The model you pass must have a primary key value set, otherwise an error will
+> be raised. In other words, you use the instance of a model returned by the
+> `insert()` method to update the record as it has the primary key value set,
+> not the original instance you passed to `insert()`.
+>
+> You can also set the primary key value on the model instance manually before
+> calling `update()` if you have that.
+
 ## Deleting Records
 
 To delete a record from the database, you need to pass the model class and the

docs/guide/models.md

@@ -76,6 +76,41 @@ to the primary key index (`pk`) that is automatically created.
 > You can specify both `indexes` and `unique_indexes` in the `Meta` class if you
 > need to.
 
+### Unique Fields
+
+You can also specify that a field should be all unique values by using the
+`Unique()` method from the `sqliter.model` module. This will ensure that all
+values in this field are unique.
+
+```python
+from typing import Annotated
+from sqliter.model import BaseDBModel, Unique
+
+class User(BaseDBModel):
+    name: str
+    age: int
+    email: Annotated[str, Unique()]
+```
+
+This will raise either a `RecordInsertionError` or `RecordUpdateError` if you
+try to insert or update a record with a duplicate value in the chosen field.
+
+> [!TIP]
+>
+> Using `Annotated` is optional, but without it your code wil not pass
+> type-checking with `mypy`. It will work fine at runtime but is not recommended:
+>
+> ```python
+>     email: str = Unique()
+>
+>```
+>
+> This will give the following Mypy error:
+>
+> ```pre
+> error: Incompatible types in assignment (expression has type "Unique", variable has type "str")  [assignment]
+>```
+
 ### Custom Table Name
 
 By default, the table name will be the same as the model name, converted to

docs/index.md

@@ -40,6 +40,7 @@ database-like format without needing to learn SQL or use a full ORM.
 - Table creation based on Pydantic models
 - Automatic primary key generation
 - User defined indexes on any field
+- Set any field as UNIQUE
 - CRUD operations (Create, Read, Update, Delete)
 - Chained Query building with filtering, ordering, and pagination
 - Transaction support

tests/test_unique.py

@@ -6,8 +6,7 @@
 
 from sqliter import SqliterDB
 from sqliter.exceptions import RecordInsertionError, RecordUpdateError
-from sqliter.model import BaseDBModel
-from sqliter.model.unique import Unique
+from sqliter.model import BaseDBModel, Unique
 
 
 class TestUnique: