archeryutils
A collection of archery code and utilities in python
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.8%) to scientific vocabulary
Keywords
Repository
A collection of archery code and utilities in python
Basic Info
- Host: GitHub
- Owner: jatkinson1000
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://archeryutils.readthedocs.io
- Size: 607 KB
Statistics
- Stars: 14
- Watchers: 3
- Forks: 3
- Open Issues: 17
- Releases: 3
Topics
Metadata Files
README.md
archeryutils
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, and Archery Australia 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.
Try now!
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
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.
Installation
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 .
or, for full developer dependencies:
python3 -m pip install -e .[dev]
Please refer to the online documentation for full installation guidance including optional dependencies for developing and testing.
Getting Started
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.
License
Copyright © Jack Atkinson
archeryutils is distributed under the MIT Licence.
Authors and Acknowledgment
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.
Used by
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
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.
Code of Conduct
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.
Support
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.
Owner
- Name: Jack Atkinson
- Login: jatkinson1000
- Kind: user
- Company: @Cambridge-ICCS
- Website: https://jackatkinson.net
- Repositories: 27
- Profile: https://github.com/jatkinson1000
Citation (CITATION.cff)
# YAML 1.2
---
cff-version: 1.2.0
title: "ArcheryUtils"
license: MIT
repository-code: "https://github.com/jatkinson1000/archeryutils"
url: ""
version: ""
date-released: 2022-12-13
type: software
authors:
- given-names: Jack
family-names: Atkinson
affiliation: The University of Cambridge
alias: jatkinson1000
orcid: "https://orcid.org/0000-0001-5001-4812"
- given-names: Liam
family-names: Pattinson
affiliation: The University of York
alias: LiamPattinson
message: "If you use this software, please cite it using these metadata."
GitHub Events
Total
- Create event: 29
- Release event: 2
- Issues event: 18
- Watch event: 3
- Delete event: 24
- Issue comment event: 297
- Push event: 125
- Pull request review comment event: 47
- Pull request review event: 59
- Pull request event: 54
- Fork event: 1
Last Year
- Create event: 29
- Release event: 2
- Issues event: 18
- Watch event: 3
- Delete event: 24
- Issue comment event: 297
- Push event: 125
- Pull request review comment event: 47
- Pull request review event: 59
- Pull request event: 54
- Fork event: 1
Issues and Pull Requests
Last synced: 7 months ago
All Time
- Total issues: 10
- Total pull requests: 22
- Average time to close issues: 2 months
- Average time to close pull requests: 10 days
- Total issue authors: 2
- Total pull request authors: 2
- Average comments per issue: 1.0
- Average comments per pull request: 1.59
- Merged pull requests: 13
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 9
- Pull requests: 22
- Average time to close issues: about 1 month
- Average time to close pull requests: 10 days
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 1.11
- Average comments per pull request: 1.59
- Merged pull requests: 13
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- jatkinson1000 (25)
- TomHall2020 (6)
- LiamPattinson (4)
Pull Request Authors
- jatkinson1000 (46)
- TomHall2020 (8)
- mjtamlyn (3)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 73 last-month
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 4
- Total maintainers: 1
pypi.org: archeryutils
A collection of archery utilities in python.
- Homepage: https://github.com/jatkinson1000/archeryutils
- Documentation: https://archeryutils.readthedocs.io/
- License: MIT License Copyright (c) 2022 Jack Atkinson Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
Latest release: 1.1.1
published over 1 year ago
Rankings
Maintainers (1)
pypi.org: archeryutils-jatkinson1000
A collection of archery utilities in python.
- Homepage: https://github.com/jatkinson1000/archeryutils
- Documentation: https://archeryutils.readthedocs.io/
- License: MIT License Copyright (c) 2022 Jack Atkinson Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
Latest release: 1.0.0
published almost 2 years ago
Rankings
Maintainers (1)
Dependencies
- black >=22.12.0
- flake8 ==6.0.0
- numpy >=1.20.3
- actions/checkout v3 composite
- actions/setup-python v4 composite
- codecov/codecov-action v3 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- psf/black stable composite
- actions/checkout v3 composite
- actions/setup-python v4 composite