athlib
Athlib is a library of functions, data and schema for Athletics (i.e. Track and Field)
We're building lots of sites for the sport of athletics. When we find something common and testable, we aim to place it here. This library should contain
- static reference data, provided it's not huge nor available elsewhere
- Python code implementing functions of general interest
- Javascript code implementing functions of general interest
It is NOT intended to contain
- web applications, view code or database code.
- competition management software
Things we hope to put in here:
- standard event codes and their English names
- UKA and other age group calculators
- WMA age grade calculations
- utilities for parsing and formatting performances as commonly input in athletics
- standardised scoring functions
- sample JSON files in line with our schemas
- schemas to validate
What follows below is intended to help people working on athlib.
Python documentation
We require a modern python>=3.8.0 some functions already have typing information and it will be applied later to others.
Installation
pip install athlib
Python development
For Python developers, please install the extra development requirements with
pip install -r dev_requirements.txt
Run tests with...
python setup.py test
Check style with
pycodestyle --exclude=bin,lib,include,sampledata
You can also copy the file pre-commit.sample to .git/hooks/pre-commit, and the two above checks will be run before any commit, and block it if they return issues.
Javascript documentation & development
see the documentation in folder js
Documentation itself
The docs are written using reStructured Text, the Python standard. There is an environment
in docs.
cd docs
make html
4 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file athlib-0.9.8-py2.py3-none-any.whl.
File metadata
- Download URL: athlib-0.9.8-py2.py3-none-any.whl
- Upload date:
- Size: 188.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
06e3d8b94a3ffbc64db1243c638a83cb1a0e982f9f14758254c0547c8cc54707
|
|
| MD5 |
96890043615471b77ab6c8255d4f5d59
|
|
| BLAKE2b-256 |
0606bc22276807abe2e30c7aa66cf5ea83ec5eb2e1cf440de8a80872bfc449ca
|
