Command-line interface to Sepior pipeline server.
Project description
Command-line interface to the Sepior Pipeline.
Requirements
Python 3.5
Install using pyenv or pyvenv
Installation
$ pip install pipeline_cli
Usage
The tool will show a description of usage when given the –help option:
$ pipeline --help
usage: pipeline [-h] [--version] [--host HOST_NAME] {start,enqueue} ...
The pipeline utility
positional arguments:
{start,enqueue} sub-commands
start start help
enqueue enqueue downstream dependencies help
optional arguments:
-h, --help show this help message and exit
--version, -v show programs version number and exit
--host HOST_NAME specify pipeline server host. Default is
https://pipeline.sepior.net```
The tool is able to: 1. start a pipeline 2. enqueue downstream pipelines
Starting a pipeline
We assume you already have a pipeline file. If the pipeline file is in the current directory then simply run
$ pipeline start <version>
See pipeline start –help for more advanced usecases.
Enqueue downstream pipelines
This command is relevant if the pipeline you have is building inside the pipeline or if you manually want to (re)start downstream pipelines.
See pipeline enqueue –help for parameters.
Building the tool
Make sure you have a Python 3.5 environment with the requirements.
E.g. use pyenv:
$ pyenv virtualenv 3.5.0 pipeline-cli-venv
$ pyenv activate pipeline-cli-venv
Make sure pip is up-to-date:
$ pip install --upgrade pip
Install requirements:
$ pip install --upgrade -r requirements.txt
Build the wheel:
$ make
Development
Use the following command to install the package in the local environment during development.
$ pip install -e .
This allows you to change the code and test the pipeline cli directly.
Contributing
When contributing changes remember to update the CHANGELOG.md.
License
Proprietary. Copyright 2016 Sepior ApS.
Releasing
Do the following to release a new version:
Commit changes
Push changes
Merge with master
Update local master
Find the next release version, e.g. 6.6.6
Create new branch with name core/release-6.6.6
Bump version in __about__.py
Run ./release.sh 6.6.6
Upload to Pypi
First, perform a test upload to verify everything is nice an dandy. Then perform the real upload.
Make sure you have a ~/.pypirc file with the following content:
[distutils]
index-servers=
pypi
pypitest
[pypitest]
repository = https://testpypi.python.org/pypi
username = <username>
[pypi]
repository = https://pypi.python.org/pypi
username = <username>
And the following environment variables have been properly defined:
$ export PYPI_TEST_PASSWORD=""
$ export PYPI_PASSWORD=""
Test upload to pypi
You may need to register on the Pypi test server. This can be done here:
$ https://testpypi.python.org/pypi
Register:
$ twine register -p ${PYPI_TEST_PASSWORD} -r pypitest dist/pipeline_cli-6.6.6-py3-none-any.whl
Upload
$ twine upload -p ${PYPI_TEST_PASSWORD} -r pypitest dist/pipeline_cli-6.6.6-py3-none-any.whl
Goto:
$ https://testpypi.python.org/pypi/pipeline-cli/6.6.6
An check that every things looks nice.
You can check the HTML by running:
$ python setup.py --long-description | rst2html.py --no-raw > output.html
Test if it installs (do it in a different environment):
$ pip install -i https://testpypi.python.org/pypi pipeline-cli
Real upload to Pypi
Upload
$ twine upload -p ${PYPI_PASSWORD} -r pypi dist/pipeline_cli-6.6.6-py3-none-any.whl
Goto:
$ https://pypi.python.org/pypi/pipeline-cli/6.6.6
An check that every things looks nice.
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
Built Distribution
Hashes for pipeline_cli-1.0.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ec8436ceaab1e6c0896877301f31ddc0f4d0aa7c896b0aa2e59e2acc5d1fc64 |
|
MD5 | 2b1b725034b02207252b2dee53d37ad2 |
|
BLAKE2b-256 | 21220449cb998ced28a9f3b9ee101ab659d61b94e8e9db277e120a1f668c36ce |