Flywheel Gear Toolkit
flywheel-gear-toolkit is a library that provides tooling for developing Flywheel gears.
Installation
pip install flywheel-gear-toolkit
If you also want to install the geartk, the gear toolkit CLI, run:
pip install flywheel-gear-toolkit[cli]
which will install the additional dependencies.
Documentation
The documentation for the flywheel-gear-toolkit can be found here.
Contributing
Building
The dependency and virtual environment manager for the gear toolkit is poetry.
poetry install
Testing
Testing, linting and building the doc can be done using the tests.sh script, after
running poetry install:
poetry run tests/bin/tests.sh
Managing dependencies
To add new dependencies to this repo, please use poetry and to follow the below steps:
# Install my-package:
poetry add my-package
# or install my-package as part of the required packages for development (e.g. pytest):
poetry add my-package --dev
# Sync poetry.lock
poetry lock
Building and releasing
Local building
To build the project locally and verify if the build was succesful, you can run
poetry build --format wheel
twine check dist/*.whl
Versioning and project information
The pyproject.toml file has replaced the usual setup.py in this repository and contains information on contributers, maintainers, project description, project URLs, and project version. In order to change any information on the project, it must be changed in the pyproject.toml, file. Documentation for this file can be found here, and information on dependency version specification syntax can be found here
CI for tagging and releasing
There is CI in place to help with tagging and releasing versions and hotfixes of the flywheel-gear-toolkit.
Automatic tagging (Not yet enabled)
When a commit that contains the word 'release' is pushed to master or a branch beginning with 'hotfix-' and there are changes to the pyproject.toml file (such as version), gitlab CI will automatically checkout the fix/release, label the branch with the tag found in the current pyproject.toml version, and push the tags.
Automatic publishing
When tags are pushed, either manually or by the previous automatic tagging CI, the publish job wil be triggered which will automatically build the project wheel and push the version to PYPI.
Metadata
Release files for flywheel-gear-toolkit 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| flywheel_gear_toolkit-0.1.2-py3-none-any.whl | Python 3 | none | any | Details for flywheel_gear_toolkit-0.1.2-py3-none-any.whl |
Release files / flywheel_gear_toolkit-0.1.2-py3-none-any.whl
| Download URL | flywheel_gear_toolkit-0.1.2-py3-none-any.whl |
|---|---|
| Size | 33.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2f7a0bdf56adf444e79ba9165a0e93646905498673c46545fa8c96d18f27bbff
|
|
BLAKE2b-256 checksum How to use checksums |
c30981d70e5f58004de1d2b00b95e2609d57c90915f0f81b548a51111b7dde5d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.4 CPython/3.8.6 Linux/4.19.78-coreos
|
Security for flywheel-gear-toolkit 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.