Welcome to ctk-cli’s documentation!

ctk-cli is a python interface for inspecting and running CLI modules (as defined by CommonTK). See http://www.commontk.org/index.php/Documentation/Command_Line_Interface

Contents:

Installation

Install package with pip

To install with pip:

$ pip install ctk-cli

Install from source

To install ctk-cli from the latest source, first obtain the source code:

$ git clone https://github.com/commontk/ctk-cli
$ cd ctk-cli

then install with:

$ pip install .

or:

$ pip install -e .

for development.

Dependencies

Python Packages

The project has a few common Python package dependencies. The runtime dependencies are:

The development dependencies (for testing and coverage) are:

codecov>=2.0.5
coverage>=4.2
flake8>=3.0.4
pytest>=3.0.3
pytest-cov>=2.4.0
pytest-runner>=2.9

Usage

ctk-cli is a python interface for inspecting and running CLI modules.

Note

To be documented

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Types of Contributions

You can contribute in many ways:

Report Bugs

Report bugs at https://github.com/commontk/ctk-cli/issues.

If you are reporting a bug, please include:

  • Any details about your CI setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

The ctk-cli project could always use more documentation. We welcome help with the official ctk-cli docs, in docstrings, or even on blog posts and articles for the web.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/commontk/ctk-cli/issues.

If you are proposing a new feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started

Ready to contribute? Here’s how to set up ctk-cli for local development.

  1. Fork the ctk-cli repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/ctk-cli.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed (pip install virtualenvwrapper), this is how you set up your cloned fork for local development:

    $ mkvirtualenv ctk-cli
$ cd ctk-cli/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8
$ python setup.py test
$ tox

    If needed, you can get flake8 and tox by using pip install to install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.7, and 3.3, 3.4, 3.5 and PyPy.

Credits

Please see the GitHub project page at https://github.com/commontk/ctk-cli/graphs/contributors

History

ctk-cli was initially developed in June 2013 by Hans Meine, Jean-Christophe Fillion-Robin and Steve Pieper during the 17th NA-MIC summer project week.

How to Make a Release

A core developer should use the following steps to create a release of ctk-cli.

  1. Configure ~/.pypirc as described here.

  2. Make sure that all CI tests are passing.

  3. Tag the release. Requires a GPG key with signatures. For version X.Y.Z:

    git tag -s -m "ctk-cli X.Y.Z" X.Y.Z upstream/master

  4. Create the source tarball and binary wheels:

    git checkout master
git fetch upstream
git reset --hard upstream/master
rm -rf dist/
python setup.py sdist bdist_wheel

  5. Upload the packages to the testing PyPI instance:

    twine upload --sign -r pypitest dist/*

  6. Check the PyPI testing package page.

  7. Upload the packages to the PyPI instance:

    twine upload --sign dist/*

  8. Check the PyPI package page.

  9. Make sure the package can be installed:

    mkvirtualenv test-pip-install
pip install ctk_cli
rmvirtualenv test-pip-install

Indices and tables

Resources