Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request. I would like to keep the library to be safe as possible, so i would appreciate if you cover any new feature with tests to maintain 100% coverage.

Install in a development environment

1. First, clone the repository:

   git clone git@github.com:SpaceShaman/ORMagic.git
   

2. Install poetry if you don't have, here you can find the instructions

3. Create a virtual environment and install the dependencies:

   cd ORMagic
   poetry install --no-root
   

4. Activate the virtual environment:

   poetry shell
   

Run tests

If you in the virtual environment, you can run the tests with the following command:

pytest

You can also run the tests with coverage:

pytest --cov=ormagic