A collection of archery code and utilities in python.
Designed to make the development of archery codes and apps easier.
Contains:
- generic representations of targets and rounds
- World Archery, Archery GB, IFAA rounds
- calculations for Archery GB handicaps and Archery Australia archer skill level
- calculation of Archery GB classifications
Full documentation, including an API reference, is available on read the docs.
You can play with this library as a
binder instance
right now without installing anything.
If you want to use it locally in your own code follow the usage instructions below for
installation and getting started.
Usage is allowed under the licensing specified.
We encourage usage and welcome feature requests.
It is appreciated if visible credit is given by any projects using archeryutils.
To install the library via pip for use in a project you can run:
pip install archeryutils
It is recommended to use a virtual environment.
If you want a local install that you can edit instead, clone the repository,
navigate to archeryutils/, and run:
python3 -m pip install -e .[test,lint,docs]
Please refer to the online documentation for full installation guidance.
There are examples of some of the different functionalities in the jupyter notebook
examples.ipynb.
This can be run from a local install using:
pip install notebook
jupyter notebook examples.ipynb
Alternatively, you can use it online through the binder instance as described above.
Copyright © Jack Atkinson
archeryutils is distributed under the MIT Licence.
See Contributors for a full list of contributors towards this project.
If you use this software in your work, please provide visible credit/citation. CITATION.cff provides citation metadata, which can also be accessed from GitHub.
The following projects make use of this code or derivatives in some way:
- archerycalculator
- MyTargets
- Golden Records
- Expert Archer
Are we missing anyone? Let us know.
If you make use of archeryutils in a commercial product please consider supporting the project to ensure its continued development and longevity.
Contributions and collaborations are welcome from anyone with an interest in python and archery.
Please refer to the online documentation for full
contributing guidelines.
Read and follow this when opening
issues
or
pull requests.
For bugs, feature requests, and clear suggestions for improvement can be documented by opening an issue. For more abstract ideas for the project please open a discussion.
If you built something upon archeryutils that would be useful to others, or can address an open issue, please fork the repository and open a pull request.
Everyone participating in the archeryutils project, and in particular in the issue tracker, pull requests, and social media activity, is expected to treat other people with respect and more generally to follow the guidelines articulated in the Python Community Code of Conduct.
This project is developed by volunteers for the benefit of the archery community. It is dedicated to remain a FOSS project. The best way to support this project, if you are able, is by directly contributing.
If you are unable to do this, however, financial support towards this and the archerycalculator project can be given through Buy me a coffee or donating via paypal. This allows me to spend time improving the library.