Developer guide
This guide provides instructions for setting up a development environment, running tests, and contributing to ezesri.
Setting up a development environment
To get started, clone the repository and install the package in editable mode with the docs extras:
git clone https://github.com/stiles/ezesri.git
cd ezesri
pip install -e .[docs]
Running tests
This project uses pytest for unit testing. To run the test suite, simply run the following command:
pytest
For more details, see the testing guide.
Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue to discuss your ideas.
Code style
- Follow PEP 8 guidelines
- Use type hints where appropriate
- Write docstrings for public functions
Pull request process
- Fork the repository
- Create a feature branch
- Make your changes
- Run the test suite
- Submit a pull request