cirrus

python library build, test and devop like things assistant

Installation Prerequisites

• Cirrus requires either python/pip/virtualenv or conda and has been tested with python2.7, 3.5 and 3.6 as of Release 0.2.0.
  • Since python3 support and conda support are fairly new, please report any problems as Issues in this project.
• Git tools are heavily used, git is a requirement as cirrus is accessed via git command aliases.

Documentation

Expanded Docs are available on the Package Wiki

Installation as a user:

pip install virtualenv 
curl -O https://raw.githubusercontent.com/evansde77/cirrus/develop/installer.sh
bash installer.sh

Or if you are using anaconda:

curl -O https://raw.githubusercontent.com/evansde77/cirrus/develop/conda-installer.sh
bash conda-installer.sh

See the

Installation for Development:

Note: This package uses GitFlow, any development work should be done off the develop branches and pull requests made against develop, not master.

git clone https://github.com/evansde77/cirrus.git
cd cirrus
git cirrus build

For more detailed docs see the Installation Docs

Package Configuration Files:

The per package controls used by cirrus live in a cirrus.conf file in the top level of the repo you use with cirrus. This file, coupled with the cirrus setup.py template and command line tools dictate the behaviour of the cirrus commands within the package. Details for the cirrus config are in the Cirrus Configuration Docs

Cirrus Commands:

See the Cirrus Commands Docs

• git cirrus hello - Install check and version info
• git cirrus build - Create a development environment
• git cirrus test - Run test suites
• git cirrus release - Release code and push to pypi
• git cirrus feature - Work on new features
• git cirrus docker-image - Build and release container images
• git cirrus selfupdate - Update cirrus
• git cirrus qc - Run quality control and code standard tests
• git cirrus docs - Build sphinx package docs
• git cirrus review - Helper for GitHub Pull Requests