pipeline-utils 0.0.1

Utility functions for Coral Atlas Pipelines

proc_pipeline_utils

Shared utility functions for Coral Atlas data pipelines

Development

This project uses Pipenv to manage virtual environments and dependencies. Development-time dependencies are documented in the Pipfile. Follow the Pipenv documentation to create a virtual environment and install the dependencies.

Makefile

The included Makefile prescribes actions to test, build, and publish this code to a Python Package Index (PyPI) repository as described in the following sections.

$ make [test | build | publish]

Testing

With the virtual environment active and the dependencies installed, use pytest to run the test suite.

To run the unit tests, run:

$ pipenv run pytest

Building

This project uses the setuptools Python package for packaging as described here.

When building via the make build command, you may optionally append to the package name using the prerelease argument. For example, if the current version of pipelines_utils specified in the setup.py module is 1.0.1, then

$ make build prerelease=rc1

will produce a package named pipelines_utils-1.0.1rc1. The default is a beta prerelease name incremented by each git commit (eg/ 1.0.1b7 for the seventh commit on this branch). Specify a final release with

$ make build prerelease=""

Note that prerelease names must comply with PEP 440.

Publishing

This project uses the twine Python package for distribution as described here.

When publishing via the make publish command, the default PyPI repository is testpypi. To publish to pypi.org, specify that repository:

$ make publish pypi_repository=pypi

The credentials necessary to publish to the target PyPI repository can be provided in one of two ways.

1. As these environment variables:

Env Var	Notes
PYPI_REPOSITORY_USERNAME	PyPI account username. If authenticating using a token, use the literal string __token__.
PYPI_REPOSITORY_PASSWORD	PyPI account password. If authenticating using a token, use the token contents.

2. At the make publish command:

$ make publish pypi_repository=pypi pypi_repository_username="foo" pypi_repository_password="bar"