Utilities for Phylum integrations
Project description
phylum-ci
Python package for handling CI and other integrations
Local Development
Here's how to set up phylum-ci
for local development.
-
Clone the
phylum-ci
repo locallygit clone git@github.com:phylum-dev/phylum-ci.git
-
Ensure all supported Python versions are installed locally
- The strategy is to support all released minor versions of Python that are not end-of-life yet
- The current list is 3.7, 3.8, 3.9, and 3.10, but the Python Developer's Guide can be referenced for the status of active Python releases
- It is recommended to use
pyenv
to manage multiple Python installations
# Use `pyenv install --list` to get available versions and usually install the latest patch version. # NOTE: These versions are examples; the latest patch version available from pyenv should be used in place of `.x`. # example: `pyenv install --list |grep 3.9.` to show latest patch version for the cpython 3.9 minor release. pyenv install 3.7.x pyenv install 3.8.x pyenv install 3.9.x pyenv install 3.10.x pyenv rehash # Ensure all environments are available globally (helps tox to find them) pyenv global 3.10.x 3.9.x 3.8.x 3.7.x
-
Ensure poetry is installed
-
Install dependencies with
poetry
, which will automatically create a virtual environment:cd phylum-ci poetry install
-
Create a branch for local development:
git checkout -b <name-of-your-branch>
Now you can make your changes locally.
-
If new dependencies are added, ensure the
poetry.lock
file is updated (and committed):poetry lock
-
When you're done making changes, check that your changes pass the tests:
poetry run tox
-
Commit your changes and push your branch to GitHub:
git add . git commit -m "Description of the changes goes here" git push --set-upstream origin <name-of-your-branch>
-
Submit a pull request through the GitHub website
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for phylum_ci-0.0.2rc3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd0dbe46fdce64965689a0ca9c8e54ee3334ce5982bf00513652fdf3a7c670c1 |
|
MD5 | 49b92e04db715ce81de4cb501bbbf230 |
|
BLAKE2b-256 | a1aa1bc222c617400712ac8ea51a8dfd0fd0a83890c21c588148e4cc2148c166 |