Skip to main content

Framework for building command-line tools

Project description

Build Status

Introduction

yaclifw is a framework for building CLI tools.

Dependencies

Direct dependencies of yaclifw are:

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 ..

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yaclifw-0.2.0.tar.gz (13.6 kB view details)

Uploaded Source

File details

Details for the file yaclifw-0.2.0.tar.gz.

File metadata

  • Download URL: yaclifw-0.2.0.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for yaclifw-0.2.0.tar.gz
Algorithm Hash digest
SHA256 832c60cfcb8389459c544dfde569caa5dd19978facf0b76df87b9734eb85282a
MD5 d6182b1b4bd24ae2ffc79a463808c2e2
BLAKE2b-256 4858f6ae8938d8726f9ba91a5245a02413953a62ce09aae01345b0ef189925b1

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page