Skip to content

jatkinson1000/archerycalculator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Python 3.7+ Code style: black

paypal Buy Me A Coffee


archerycalculator

Code for the archerycalculator.co.uk website.
This is a flask application for calculating archery handicaps and classifications. It is largely built on top of the archeryutils package.

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 archerycalculator.

Installation

To install, clone the repository, navigate to archerycalculator/, and run:

python3 -m pip install .

It is recommended to use a virtual environment.

Getting Started

This is a flask app.
After installing you can initialise the project databases and start the app running by running:

flask --app archerycalculator init-db

flask --app archerycalculator run

This will start the app running on http://127.0.0.1:5000/ (usually), which can be opened in a browser.

License

Copyright © Jack Atkinson

archerycalculator is distributed under the MIT Licence.

Authors and Acknowledgment

See Contributors for a list of contributors towards this project.

If you use this software in your work, please provide visible credit/citation.

Contributions

Contributions and collaborations are welcome from anyone with an interest in python and archery.

For bugs, feature requests, and clear suggestions for improvement please open an issue. For more abstract ideas for the project please open a discussion.

If you built upon archerycalculator something that would be useful to others, or can address an open issue, please fork the repository and open a pull request.

It is expected that code has been run and tested before a PR is submitted, and that any developments are clearly described in the discussion and commit messages.

Code of Conduct

Everyone participating in the archerycalculator 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.

One way to support this project is by directly contributing.
See above for how to help with open issues or contribute back any improvements.

Financial support towards archerycalculator.co.uk, for those who can afford it, can be given through Buy me a coffee or donating via paypal.
This will primarily be used to pay domain and hosting costs.

paypal Buy Me A Coffee

About

Code for the web app archerycalculator.co.uk providing archery handicaps and classifications

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published