ASWF Docker Utilities
Project description
ASWF Python Utilities
The aswfdocker
command line tool is available to help with package and image builds.
Installation
For users:
git clone https://github.com/AcademySoftwareFoundation/aswf-docker
cd aswf-docker
python3 setup.py install
For developers:
First install pipenv for Python 3: pip3 install pipenv
.
Then:
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 OK:black python
- run the tests to ensure everything is OK:
pytest python/aswfdocker
- run mypy to ensure static types are OK:
mypy python/aswfdocker
- run
prospector
on the code to ensure linting is OK:prospector -F python/aswfdocker
To run them all manually use pre-commit run --all-files
.
Adding new pip dependencies
- Run
pipenv install xyz
- Run
pipenv-setup sync
to updatesetup.py
with added dependency (pipenv-setup
is a "dev" dependency already declared inPipFile
)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
aswfdocker-0.4.0.tar.gz
(20.5 kB
view hashes)
Built Distribution
aswfdocker-0.4.0-py3-none-any.whl
(34.5 kB
view hashes)
Close
Hashes for aswfdocker-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 721d52a276c781b02b1360a95babcbaa345ffda32479fdc18ed6f2c5bbf2af54 |
|
MD5 | 2ce71fbc77ea2857c0d6e07f0fc97166 |
|
BLAKE2b-256 | 98b86cfc82ef2e7d4af46691da9894a5799131ca9c1979c3aee82faf1a5f6ae0 |