Skip to content

Commit

Permalink
Update README file in pyproject.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
subhashb committed Jun 21, 2024
1 parent b0979a8 commit a056cd0
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions docs/guides/compose-a-domain/initialize-domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ exposes them in a registry.

## 3. Inject dependencies

Calling `domain.init()` establishes connectivity with the underlying infra,
testing access, and making them available for use by the rest of the system.

By default, a protean domain is configured to use in-memory replacements for
infrastructure, like databases, brokers, and caches. They are useful for
testing and prototyping. But for production purposes, you will want to choose
a database that actually persists data.

Calling `domain.init()` establishes connectivity with the underlying infra,
testing access, and making them available for use by the rest of the system.

```python hl_lines="5-9 11"
{! docs_src/guides/composing-a-domain/017.py !}
```
Expand Down
8 changes: 4 additions & 4 deletions docs_src/guides/composing-a-domain/017.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

domain = Domain(__file__, load_toml=False)

domain.config["DATABASES"]["default"] = {
"PROVIDER": "protean.adapters.repository.sqlalchemy.SAProvider",
"DATABASE": "SQLITE",
"DATABASE_URI": "sqlite:///:memory:",
domain.config["databases"]["default"] = {
"provider": "sqlalchemy",
"database": "sqlite",
"database_uri": "sqlite:///test.db",
}

domain.init(traverse=False)
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ version = "0.12.1"
description = "Protean Application Framework"
authors = ["Subhash Bhushan C <[email protected]>"]
license = "BSD 3-Clause"
readme = "README.rst"
readme = "README.md"
repository = "https://github.com/proteanhq/protean"
documentation = "https://protean.readthedocs.io/en/latest/"
keywords = [
Expand Down

0 comments on commit a056cd0

Please sign in to comment.