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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
aswfdocker-0.3.2-py3-none-any.whl
(33.9 kB
view hashes)
Close
Hashes for aswfdocker-0.3.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f12b7944469303f5204a0cbc843416084ddde827c8cdd6c787f6f2cacb8fdc02 |
|
MD5 | 7aeb85022e2d263b4adf3365d99736ce |
|
BLAKE2b-256 | bf7185005b539813da66a16ae2c4d710fe122863a3643868a3136141b767ff7a |