Fork this repository on GitHub, and clone locally with git clone.
Use pyenv to manage multiple versions of Python. This can be easily installed with pyenv-installer.
Python projects in this repository, including the bundle-workflow project, use Python 3.7. See the Python Beginners Guide if you have never worked with the language.
$ python3 --version
Python 3.7.11
If you are using pyenv.
$ pyenv install 3.7.11
This project uses pipenv, which is typically installed with pip install --user pipenv. Pipenv automatically creates and manages a virtualenv for your projects, as well as adds/removes packages from your Pipfile as you install/uninstall packages. It also generates the ever-important Pipfile.lock, which is used to produce deterministic builds.
$ pipenv --version
pipenv, version 19.0
Install dependencies.
cd bundle-workflow
~/.../bundle-workflow $ pipenv install
Installing dependencies from Pipfile.lock (1f4869)...
🐍 ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉ 0/0 — 00:00:00
To activate this project's virtualenv, run pipenv shell.
Alternatively, run a command inside the virtualenv with pipenv run.
This project uses pytest to ensure code quality. See bundle-workflow/tests.
~/.../bundle-workflow $ pipenv run pytest
2 passed in 02s
Try running ./build.sh from bundle-workflow. It should complete and show usage.
$ ./build.sh
Installing dependencies in . ...
Installing dependencies from Pipfile.lock (41aca1)…
🐍 ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉ 14/14 — 00:00:01
To activate this project's virtualenv, run the following:
$ pipenv shell
Running ./src/run_build.py ...
usage: build.sh [-h] [-s] [-c COMPONENT] [--keep] manifest
build.sh: error: the following arguments are required: manifest
This project uses isort to ensure that imports are sorted, and flake8 to enforce code style.
$ pipenv run flake8
./src/assemble_workflow/bundle_recorder.py:30:13: W503 line break before binary operator
Use isort . to fix any sorting order.
$ pipenv run isort .
Fixing bundle-workflow/tests/system/test_arch.py
Use black to auto-format your code.
$ pipenv run black .
All done! ✨ 🍰 ✨
23 files left unchanged.
If your code isn't properly formatted, don't worry, a CI workflow will make sure to remind you.
This project uses mypy as an optional static type checker.
pipenv run mypy .
bundle-workflow/src/assemble.py:14: error: Cannot find implementation or library stub for module named "assemble_workflow.bundle"
This project uses codecov for code coverage. Use pipenv run codecov to run codecov locally.
$ pipenv run coverage run -m pytest
47 passed in 5.89s
$ pipenv run coverage report
TOTAL 23491 12295 48%
Run from bundle-workflow before making pull requests.
cd bundle-workflow
git status -s | grep -e "[MA?]\s.*.py" | cut -c4- | xargs pipenv run black
pipenv run isort .
pipenv run flake8
pipenv run pytest
pipenv run mypy .