ASWF Python Utilities
The aswfdocker command line tool is available to help with package and
image builds.
Installation
For users
Clone this repository and run the setup:
git clone https://github.com/AcademySoftwareFoundation/aswf-docker
cd aswf-docker
python3 setup.py install
For developers
Install pipenv for Python 3 first:
pip3 install pipenv
Then clone this repository, start the pipenv shell and install the dev dependencies:
git clone https://github.com/AcademySoftwareFoundation/aswf-docker
cd aswf-docker
pipenv shell
pipenv install --dev
You should now be in a Python virtualenv shell where the aswfdocker
command is available.
Finally
You should check the command is working:
aswfdocker --help
Usage
List packages and images
List all known packages:
aswfdocker packages
List all known images:
aswfdocker images
Development
Process
Once in the pipenv shell you should first install the
pre-commit hooks by running pre-commit install.
The pre-commit hooks will run the following commands, which can be run individually as well:
- Run Black on the code to ensure formatting
is okay:
black python - Run the tests to ensure everything is okay:
pytest python/aswfdocker - Run mypy to ensure static types are okay:
mypy python/aswfdocker - Run PyLint on the code to ensure
linting is okay:
pylint python/aswfdocker
To run them all manually use pre-commit run --all-files.
Adding new pip dependencies
- Run
pipenv install xyz - Run
pipenv-setup syncto updatesetup.pywith added dependency (pipenv-setupis a "dev" dependency already declared inPipfile)
Metadata
Release files for aswfdocker 0.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| aswfdocker-0.7.0.tar.gz | 38.0 kB | Without provenance | Details for aswfdocker-0.7.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| aswfdocker-0.7.0-py3-none-any.whl | Python 3 | none | any | Details for aswfdocker-0.7.0-py3-none-any.whl |
Total release size: 80.4 kB
Release files / aswfdocker-0.7.0.tar.gz
| Download URL | aswfdocker-0.7.0.tar.gz |
|---|---|
| Size | 38.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5dca598d6fefb5bcc99a7bf9b20c2f83cd34d09618b03910951f79b397520711
|
|
BLAKE2b-256 checksum How to use checksums |
90f467400d56d830899a43c99f1ce35313edc1be78a4aef5eba7bd0debeceb27
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.9.12
|
Release files / aswfdocker-0.7.0-py3-none-any.whl
| Download URL | aswfdocker-0.7.0-py3-none-any.whl |
|---|---|
| Size | 42.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1d089c454d416bbe77ff8bcfc7214923fb28588c30b45be94340cba7ac1ee7d9
|
|
BLAKE2b-256 checksum How to use checksums |
9d7a0147f42f8a436c37d51b43696b92150d74e18c5bcfc2543fcd6ed5022367
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.9.12
|
Security for aswfdocker 0.7.0
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.