https://github.com/runemalm/ddd-for-python
A domain-driven design framework for Python.
https://github.com/runemalm/ddd-for-python
ddd domain-driven-design hexagonal-architecture
Last synced: 5 months ago
JSON representation
A domain-driven design framework for Python.
- Host: GitHub
- URL: https://github.com/runemalm/ddd-for-python
- Owner: runemalm
- License: gpl-3.0
- Created: 2021-03-14T09:36:15.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2022-03-13T16:54:15.000Z (over 4 years ago)
- Last Synced: 2024-08-09T22:35:27.469Z (almost 2 years ago)
- Topics: ddd, domain-driven-design, hexagonal-architecture
- Language: Python
- Homepage:
- Size: 3.67 MB
- Stars: 84
- Watchers: 6
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## ddd-for-python
This is a framework for developing apps based on domain-driven design.
The design is inspired by Vaughn Vernon's reference implementation of DDD in Java.
A little bit of inspiration also comes from django.
### Purpose:
The goal of this project is to provide a complete framework for implementing DDD bounded contexts in Python.
Read the user guide in the [documentation](https://ddd-for-python.readthedocs.io/en/latest/) to get started. You can also look at the [example code](https://github.com/runemalm/ddd-for-python/tree/develop/examples/webshop/shipping) of the 'shipping' context.
Star and/or follow the project to receive notifications when version 1.0.0 is released.
### Design:
The design is based on these patterns:
- DDD (collection of patterns)
- Hexagonal Architecture
- Near-infinite Scalability ("Entity" concept)
- xUnit (for testing)
### Theory:
The following sources are recommended:
- [Domain-Driven Design: Tackling Complexity in the Heart of Software - Eric Evans](https://www.amazon.com/Domain-Driven-Design-Tackling-Complexity-Software/dp/0321125215)
- [Implementing Domain-Driven Design - Vaughn Vernon](https://www.amazon.com/Implementing-Domain-Driven-Design-Vaughn-Vernon/dp/0321834577)
- [Hexagonal Architecture - Alistair Cockburn](https://alistair.cockburn.us/hexagonal-architecture/)
- [Life Beyond Distributed Transactions - Pat Helland](https://queue.acm.org/detail.cfm?id=3025012)
- [xUnit - Wikipedia](https://en.wikipedia.org/wiki/XUnit)
### Supported Python Versions:
- Tested with python 3.8.5.
- Should work with any version >= 3.8.0 (not tested).
### Installation:
```bash
$ pip install ddd-for-python
```
### Example:
```python
# This is the "main.py" file that
# starts the bounded context in a container.
from ddd.application.config import Config
from ddd.infrastructure.container import Container
from shipping.utils.dep_mgr import DependencyManager
from shipping.application.shipping_application_service import \
ShippingApplicationService
if __name__ == "__main__":
"""
This is the container entry point.
Creates the application service and runs it in the container.
"""
# Config
config = Config()
# Dependency manager
dep_mgr = \
DependencyManager(
config=config,
)
# Application service
service = \
ShippingApplicationService(
customer_repository=dep_mgr.get_customer_repository(),
db_service=dep_mgr.get_db_service(),
domain_adapter=dep_mgr.get_domain_adapter(),
domain_publisher=dep_mgr.get_domain_publisher(),
event_repository=dep_mgr.get_event_repository(),
interchange_adapter=dep_mgr.get_interchange_adapter(),
interchange_publisher=dep_mgr.get_interchange_publisher(),
job_adapter=dep_mgr.get_job_adapter(),
job_service=dep_mgr.get_job_service(),
log_service=dep_mgr.get_log_service(),
scheduler_adapter=dep_mgr.get_scheduler_adapter(),
shipment_repository=dep_mgr.get_shipment_repository(),
max_concurrent_actions=config.max_concurrent_actions,
loop=config.loop.instance,
)
# ..register
dep_mgr.set_service(service)
# Container
container = \
Container(
app_service=service,
log_service=dep_mgr.get_log_service(),
)
# ..run
loop = config.loop.instance
loop.run_until_complete(container.run())
loop.close()
```
For the full code, see: "examples/webshop/shipping".
### Documentation:
You can find the latest [documentation](https://ddd-for-python.readthedocs.io/en/latest/) at readthedocs.
### Contribution:
If you want to contribute to the code base, create a pull request on the develop branch.
### Release Notes:
**0.9.5** - 2022-03-13
- Added [documentation](https://ddd-for-python.readthedocs.io/en/latest/).
- Moved db_service related classes.
- Moved event related classes.
- Added MemoryPostgresDbService to be able to run tests against an in-memory postgres database.
- Fixed bug: container kwarg in example main.py (thanks euri10).
**0.9.4** - 2021-05-17
- Added 'context' to log service's log messages.
- Moved record filtering methods to base repository class.
- Added 'uses_service' to Task class. Deprecate 'makes_requests'.
**0.9.3** - 2021-03-27
- Searching env file from cwd by default in tests, (when no path specified).
- Refactored Task class to make it more simple.
- Refactored the configuration solution by adding a Config class.
- Added example code for 'shipping' context of a webshop application.
- Added get_all_jobs() and get_job_count() to scheduler adapter & service.
- Added missing call to _migrate() in a couple of Repository class functions.
**0.9.2** - 2021-03-15
- Fixed bug: Env file wasn't loaded in certain circumstances.
**0.9.1** - 2021-03-14
- Initial commit.