(409) Transition Protean Config to .toml file

.bumpversion.cfg

@@ -9,6 +9,6 @@ tag = True
 
 [bumpversion:file:src/protean/__init__.py]
 
-[bumpversion:file:src/protean/template/{{package_name}}/setup.py.jinja]
+[bumpversion:file:src/protean/template/domain_template/pyproject.toml]
 
 [bumpversion:file:docs-sphinx/user/installation.rst]

.gitignore

@@ -106,6 +106,9 @@ venv.bak/
 # mypy
 .mypy_cache/
 
+# ruff
+.ruff_cache/
+
 # Mr Developer
 .mr.developer.cfg
 .project

docs/guides/compose-a-domain/configuration.md

@@ -0,0 +1,33 @@
+# Configuratiion
+
+## Primary Configuration Attributes
+
+### `environment`
+
+### `debug`
+
+### `testing`
+
+### `secret_key`
+
+## Domain Configuration Attributes
+
+### `identity_strategy`
+
+### `identity_type`
+
+### `command_processing`
+
+### `event_processing`
+
+### `snapshot_threshold`
+
+## Adapter Configuration
+
+### `database`
+
+### `cache`
+
+### `broker`
+
+### `event_store`

docs/guides/domain-definition/aggregates.md

@@ -131,7 +131,7 @@ NotSupportedError: TimeStamped class has been marked abstract and cannot be inst
 Specifies the database that the aggregate is persisted in.
 
 Aggregates are connected to underlying data stores via providers. The
-definitions of these providers are supplied within the `DATABASES` key in the
+definitions of these providers are supplied within the `databases` key in the
 Domain’s configuration. Protean identifies the correct data store, establishes
 the connection and takes responsibility of persisting the data.
 

docs/guides/domain-definition/fields/simple-fields.md

@@ -139,7 +139,7 @@ identifier.
 **Optional Arguments**
 
 - **`increment`**: Auto-increment field value. Defaults to `False`. Only valid
-when `IDENTITY_TYPE` is `INTEGER` and `IDENTITY_STRATEGY` is set to `DATABASE`.
+when `identity_type` is `INTEGER` and `identity_strategy` is set to `DATABASE`.
 
 !!!note
     Not all databases support this `increment` feature. Cross-verify with the
@@ -154,7 +154,7 @@ If you want to supply values, use [`Identifier`](#identifier) fields.
 ```
 
 By default, Protean depends on UUIDs as identifier values. You can use the
-`IDENTITY_TYPE` config attributes to customize this behavior and choose
+`identity_type` config attributes to customize this behavior and choose
 another type (like integer values). 
 
 ```shell hl_lines="6"
@@ -172,7 +172,7 @@ in Protean.
 ## Identifier
 
 An Identifier. The identity type is String type by default, but can be changed
-with `IDENTITY_TYPE` configuration attribute for all entities, or can be set
+with `identity_type` configuration attribute for all entities, or can be set
 per entity with the `identity_type` parameter.
 
 **Optional Arguments**

docs/guides/domain-definition/identity.md

@@ -1,3 +1,3 @@
 # Identity
 
-When IDENTITY_TYPE is INTEGER, Strings that have valid integers or UUIDs are allowed
+When identity_type is INTEGER, Strings that have valid integers or UUIDs are allowed

mkdocs.yml

@@ -101,7 +101,7 @@ nav:
       - guides/compose-a-domain/when-to-compose.md
       - guides/compose-a-domain/element-decorators.md
       - guides/compose-a-domain/object-model.md
-    #  - guides/compose-a-domain/configuration.md
+      - guides/compose-a-domain/configuration.md
     - Defining Concepts:
       - guides/domain-definition/index.md
       - Fields: