Skip to main content

A command-line utility toolkit for Python.

Project description

A library for developing command-line applications in Python.

License PyPI Version Python Versions Documentation Downloads Pytest

The cmdkit library implements a few common patterns needed by well-formed command-line applications in Python. It only touches a few concepts but it implements them well. The idea is to reduce the boilerplate needed to get a full featured CLI off the ground. Applications developed using cmdkit are easy to implement, easy to maintain, and easy to understand.


Features

  • An Interface class for parsing command-line arguments.

  • An Application class that provides the boilerplate for a good entry-point.

  • A Configuration class built on top of a recursive Namespace class that provides automatic depth-first merging of dictionaries from local files, as well as automatic environment variable discovery and type-coercion.


Installation

CmdKit is built on Python 3.7+ and can be installed using Pip.

➜ pip install cmdkit

Getting Started

See the Tutorial for examples.

You can also checkout how cmdkit is being used by other projects.

Project

Description

REFITT

Recommender Engine for Intelligent Transient Tracking

hyper-shell

Hyper-shell is an elegant, cross-platform, high-performance computing utility for processing shell commands over a distributed, asynchronous queue.

delete-cli

A simple, cross-platform, command-line move-to-trash.


Documentation

Documentation for getting started, the API, and common recipes are available at cmdkit.readthedocs.io.


Contributions

Contributions are welcome in the form of suggestions for additional features, pull requests with new features or bug fixes, etc. If you find bugs or have questions, open an Issue here. If and when the project grows, a code of conduct will be provided along side a more comprehensive set of guidelines for contributing; until then, just be nice.

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

cmdkit-2.4.0.tar.gz (25.1 kB view details)

Uploaded Source

Built Distribution

cmdkit-2.4.0-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

Details for the file cmdkit-2.4.0.tar.gz.

File metadata

  • Download URL: cmdkit-2.4.0.tar.gz
  • Upload date:
  • Size: 25.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for cmdkit-2.4.0.tar.gz
Algorithm Hash digest
SHA256 2a14030399e84940a51ccbf71767cb531faa4672ee87300f64f3d015625c2600
MD5 b0a683ec69224435cbf0375cbb3edd29
BLAKE2b-256 208fb7b979305ef554fddb0edda05cb50e8aa1f0e09e03b526e18a3689e7c7d2

See more details on using hashes here.

File details

Details for the file cmdkit-2.4.0-py3-none-any.whl.

File metadata

  • Download URL: cmdkit-2.4.0-py3-none-any.whl
  • Upload date:
  • Size: 27.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for cmdkit-2.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d0eb1933bc8d7bbc40e95951d4f077b0bfdd136674998595e8942723da3db94a
MD5 847d3a183b28c18d67871d14d2041c13
BLAKE2b-256 e7d048012ed39c47a43cd1618372b5a394938c6aa94f9eff80bbfa8cae6d6eca

See more details on using hashes here.

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