ican 0.1.3

Yet another deployment system. Manage version bumping, git, etc.

ican

any deploy/build task you ask of it, the response is always: ican

dev@macbook:~/proj$ avb 

Install

Install the ican package via pypi

pip install ican

Config

Config is done via the .ican file in your project's root diarectory. Alternate file names can be configured via a master config in your home directory.

Sample .ican file

[version]
current = 0.1.6+build.40

[options]
auto-tag = True
auto-commit = True
auto-push = True
signature = True

[file1]
file = ./ican/__init__.py
style = semantic
regex = __version__\s*=\s*(?P<quote>[\'\"])(?P<version>.+)(?P=quote)

Use

You can use ican via the CLI in a typical fashion, using the format below

ican [command] [arguments] [options] 

Commands

• bump [PART]
  • PART (required)

The PART would be: The segment of the semantic version to increase.
Choices are [major, minor, patch, prerelease]

Command line options

The output and parsing of ican can be controlled with the following options.

Name	Description
--verbose	To aid in your debugging, verbose prints all messages.
--dry-run	Useful if used WITH --verbose, will not modify any files.
--version	This will displpay the current version of ican.
--defaults	Will configure ican with default settings. [^1]
--currrent	Display the current full version.
--public	Display the version in format: MAJOR.MINOR.PATCH (1.2.3)
--pep440	Display a version that conforms with pep440
--canonical	Test if the pep440 version conforms to pypi's specs
--git	Version composed of a git tag, commit sha, and distance

Examples

$ ican bump --current
0.2.7-beta.3+build.99

# Lets run a build.  Bump with no arguments defaults to bump the build number.
$ ican bump
0.2.7-beta.3+build.100

# Now its release time.  Lets bump the minor
$ ican bump minor
0.3.0+build.101

# If we wanted to use the version to build a package for pypi
$ ican bump --public
0.3.0

# Oh no a bug, let's patch
$ ican bump patch
0.3.1+build.102

# Finally, our long awaited 1.0 release.
$ ican bump major
1.0.0+build.103

# Of course, our 1.0 release will be on pypi
$ ican bump --public
1.0.0

[^1]: The defaults are version '0.1.0' with auto-tag and auto-commit OFF. For files to modify, all *.py files are searched for a version string.