https://github.com/t10d/kingdom-python-sdk
Library containing the core modules for the kingdom-python-server
https://github.com/t10d/kingdom-python-sdk
backend-development ddd-architecture domain-driven-design python python-sdk sdk sqlalchemy
Last synced: about 1 month ago
JSON representation
Library containing the core modules for the kingdom-python-server
- Host: GitHub
- URL: https://github.com/t10d/kingdom-python-sdk
- Owner: t10d
- License: mit
- Created: 2021-10-14T19:56:11.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-08T12:19:31.000Z (over 3 years ago)
- Last Synced: 2025-12-29T15:20:20.769Z (4 months ago)
- Topics: backend-development, ddd-architecture, domain-driven-design, python, python-sdk, sdk, sqlalchemy
- Language: Python
- Homepage:
- Size: 178 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🏰 Kingdom SDK
Library containing the core modules for the kingdom-python-server.
## Features
See the [changelog](./CHANGELOG.md) to see all the features supported.
## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install `kingdom-sdk`.
```bash
pip install kingdom-sdk
```
You can use [poetry](https://python-poetry.org/) as well.
```bash
poetry add kingdom-sdk
```
## Usage
```python
from kingdom_sdk.utils import files
orm_files = files.find("orm.py", "/")
```
## Test
To test the database package, you need do it manually, running a migration. Make sure the database is configured before.
```bash
cd tests/poc/
alembic revision --autogenerate
alembic upgrade head
```
The rest, run `pytest`.
Don't commit the generated revision.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)