Contributing to phidata

Phidata is an open-source project and we welcome contributions.

👩‍💻 How to contribute

Please follow the fork and pull request workflow:

Fork the repository.
Create a new branch for your feature.
Add your feature or improvement.
Send a pull request.
We appreciate your support & input!

Development setup

Clone the repository.
Create a virtual environment using the ./scripts/create_venv.sh script. This will:
- Create a phienv virtual environment in the current directory.
- Install the required packages.
- Install the phidata package in editable mode.
Activate the virtual environment using source phienv/bin/activate.

Formatting and validation

We provide a ./scripts/format.sh script that runs ruff, mypy and pytest.

Please run this script before submitting a pull request.

📝 License

This project is licensed under the terms of the MIT license

📚 Resources