Yet Another CLI Framework
=========================
|Build Status|
Introduction
------------
`yaclifw` is a framework for building CLI tools.
Dependencies
------------
Direct dependencies of yaclifw are:
- `argparse`_
Installation
------------
To install ``yaclifw``, run::
$ python setup.py install
or using pip, run::
$ pip install yaclifw
To upgrade your pip installation, run::
$ pip install -U yaclifw
Usage
-----
The list of available commands can be listed with::
$ yaclifw -h
For each subcommand, additional help can be queried, e.g.::
$ yaclifw example -h
Extending yaclifw
-----------------
The easiest way to make use of yaclifw is by cloning the
repository and modifying the main.py method to include
your own commands.
Contributing
------------
yaclifw follows `PEP 8`_, the Style Guide for Python Code. Please check your
code with pep8_ or flake8_, the Python style guide checkers, by running
``flake8 -v .`` or ``pep8 -v .``.
.. _PEP 8: http://www.python.org/dev/peps/pep-0008/
Running tests
-------------
The tests are located under the `test` directory. To run all the tests, use
the `test` target of `setup.py`::
python setup.py test
Unit tests
^^^^^^^^^^
Unit tests are stored under the `test/unit` folder and can be run by calling::
python setup.py test -t test/unit
Unit tests are also run by the Travis_ build on every Pull Request opened
against the main repository.
License
-------
yaclifw is released under the GPL.
Copyright
---------
2014, The Open Microscopy Environment
.. _argparse: http://pypi.python.org/pypi/argparse
.. _pep8: https://pypi.python.org/pypi/pep8
.. _flake8: https://pypi.python.org/pypi/flake8
.. _Travis: http://travis-ci.org/openmicroscopy/yaclifw
.. |Build Status| image:: https://travis-ci.org/openmicroscopy/yaclifw.png
:target: http://travis-ci.org/openmicroscopy/yaclifw
Raw data
{
"_id": null,
"home_page": "https://github.com/openmicroscopy/yaclifw",
"name": "yaclifw",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "The Open Microscopy Team",
"author_email": "ome-devel@lists.openmicroscopy.org.uk",
"download_url": "https://files.pythonhosted.org/packages/48/58/f6ae8938d8726f9ba91a5245a02413953a62ce09aae01345b0ef189925b1/yaclifw-0.2.0.tar.gz",
"platform": "",
"description": "Yet Another CLI Framework\n=========================\n\n|Build Status|\n\nIntroduction\n------------\n\n`yaclifw` is a framework for building CLI tools.\n\nDependencies\n------------\n\nDirect dependencies of yaclifw are:\n\n- `argparse`_\n\nInstallation\n------------\n\nTo install ``yaclifw``, run::\n\n $ python setup.py install\n\nor using pip, run::\n\n $ pip install yaclifw\n\nTo upgrade your pip installation, run::\n\n $ pip install -U yaclifw\n\nUsage\n-----\n\nThe list of available commands can be listed with::\n\n $ yaclifw -h\n\nFor each subcommand, additional help can be queried, e.g.::\n\n $ yaclifw example -h\n\nExtending yaclifw\n-----------------\n\nThe easiest way to make use of yaclifw is by cloning the\nrepository and modifying the main.py method to include\nyour own commands.\n\nContributing\n------------\n\nyaclifw follows `PEP 8`_, the Style Guide for Python Code. Please check your\ncode with pep8_ or flake8_, the Python style guide checkers, by running\n``flake8 -v .`` or ``pep8 -v .``.\n\n.. _PEP 8: http://www.python.org/dev/peps/pep-0008/\n\n\nRunning tests\n-------------\n\nThe tests are located under the `test` directory. To run all the tests, use\nthe `test` target of `setup.py`::\n\n python setup.py test\n\nUnit tests\n^^^^^^^^^^\n\nUnit tests are stored under the `test/unit` folder and can be run by calling::\n\n python setup.py test -t test/unit\n\nUnit tests are also run by the Travis_ build on every Pull Request opened\nagainst the main repository.\n\nLicense\n-------\n\nyaclifw is released under the GPL.\n\nCopyright\n---------\n\n2014, The Open Microscopy Environment\n\n.. _argparse: http://pypi.python.org/pypi/argparse\n.. _pep8: https://pypi.python.org/pypi/pep8\n.. _flake8: https://pypi.python.org/pypi/flake8\n.. _Travis: http://travis-ci.org/openmicroscopy/yaclifw\n\n.. |Build Status| image:: https://travis-ci.org/openmicroscopy/yaclifw.png\n :target: http://travis-ci.org/openmicroscopy/yaclifw",
"bugtrack_url": null,
"license": "GPLv2",
"summary": "Framework for building command-line tools",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/openmicroscopy/yaclifw"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4858f6ae8938d8726f9ba91a5245a02413953a62ce09aae01345b0ef189925b1",
"md5": "d6182b1b4bd24ae2ffc79a463808c2e2",
"sha256": "832c60cfcb8389459c544dfde569caa5dd19978facf0b76df87b9734eb85282a"
},
"downloads": -1,
"filename": "yaclifw-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "d6182b1b4bd24ae2ffc79a463808c2e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13606,
"upload_time": "2018-03-12T16:30:13",
"upload_time_iso_8601": "2018-03-12T16:30:13.544079Z",
"url": "https://files.pythonhosted.org/packages/48/58/f6ae8938d8726f9ba91a5245a02413953a62ce09aae01345b0ef189925b1/yaclifw-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2018-03-12 16:30:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openmicroscopy",
"github_project": "yaclifw",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "six",
"specs": []
}
],
"tox": true,
"lcname": "yaclifw"
}
JSON
