Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 1 KB

README.md

File metadata and controls

51 lines (32 loc) · 1 KB

🏰 Kingdom SDK

Library containing the core modules for the kingdom-python-server.

Features

See the changelog to see all the features supported.

Installation

Use the package manager pip to install kingdom-sdk.

pip install kingdom-sdk

You can use poetry as well.

poetry add kingdom-sdk

Usage

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.

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