A collection of useful simulation and analyses tools to test found.
You can install found-tools directly from PyPI:
pip install found-toolsOnce installed, you can use the command-line tools provided by the package. For example:
found-attitude --helpInterested in contributing to found-tools? Great! Follow these steps to set up your development environment.
The development setup uses an install script to ensure all necessary tools like uv and just are available.
-
Clone the repository:
git clone https://github.com/jlando/found-tools.git cd found-tools -
Run the setup script: For Windows users, please use Windows Subsystem for Linux (WSL).
The script supports Linux (with
apt-get) and macOS (withbrew).chmod +x install.sh ./install.sh
This will install all required development dependencies.
We use just to streamline common development tasks.
-
Run all checks (Lint, Types, Tests):
just check-all
-
Run tests:
just test -
Lint and format code:
just lint
All work should be done on a feature branch. Before opening a pull request, you must increment the version in pyproject.toml on your feature branch. Follow semantic versioning:
- PATCH for backward-compatible bug fixes (e.g.,
0.1.0→0.1.1). - MINOR for adding functionality in a backward-compatible manner (e.g.,
0.1.0→0.2.0). - MAJOR for incompatible API changes.
Once your work is complete and the version is updated, open a pull request to merge into the main branch.
Deployment is automated via GitHub Actions using the publish.yml workflow. The workflow is triggered when a new tag starting with v (e.g., v0.1.0) is pushed to the main branch.
To release a new version after your pull request has been merged:
- Check out the
mainbranch locally and pull the latest changes. - Tag the release on the
mainbranch:git tag vX.Y.Z
- Push the tag to GitHub:
git push origin vX.Y.Z
This only works if you properly incremented the version in the pyproject.toml file before making the pull-request.