Skip to main content

A library for developing command-line applications in Python.

License PyPI Version Python Versions Documentation Downloads

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.

Metadata

Release files for cmdkit 2.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cmdkit 2.2.1
File Size Uploaded
cmdkit-2.2.1.tar.gz 21.1 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for cmdkit 2.2.1
File Interpreter ABI Platform
cmdkit-2.2.1-py3-none-any.whl Python 3 none any Details
cmdkit-2.2.1-py2-none-any.whl Python 2 none any Details

Total release size: 80.7 kB

Release files / cmdkit-2.2.1.tar.gz

Download URL cmdkit-2.2.1.tar.gz
Size 21.1 kB
Tags Source
SHA-256 checksum
How to use checksums
4021d2b3a0b38066bf3ef8c25d92461d02a2179ae33c8fbb30bc65a442e8f77d
BLAKE2b-256 checksum
How to use checksums
5a0be99f7c57960ab5bc2c6d61ee716801d615af93112cc8417794e3d884142a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.2.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.7

Release files / cmdkit-2.2.1-py3-none-any.whl

Download URL cmdkit-2.2.1-py3-none-any.whl
Size 29.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
758e60d6b070e36a238b10da67c1ca76714f3f0a0671eb804b3844de514d0c59
BLAKE2b-256 checksum
How to use checksums
62aeb1d9e2c5e5dc80cde6bdae9b95ea155abdfd741d5fc5dc9cf82b9c7ef573
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.2.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.7

Release files / cmdkit-2.2.1-py2-none-any.whl

Download URL cmdkit-2.2.1-py2-none-any.whl
Size 29.8 kB
Tags Python 2
SHA-256 checksum
How to use checksums
c50d516193922d6141b8d7e8c6a675a49b6a3e0f2a2a5e8951ea189bf88645f5
BLAKE2b-256 checksum
How to use checksums
41910f300b05cb81781537c3ceac8d7e2e3eae0e34e9d7be58bac63cab14e920
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.2.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.7

Release history Release notifications | RSS feed

2.7.7

2 release files

2.7.6

2 release files

2.7.5

2 release files

2.7.4

2 release files

2.7.3

2 release files

2.7.2

2 release files

2.7.1

2 release files

2.6.1

2 release files

2.6.0

2 release files

2.5.1

2 release files

2.5.0

2 release files

2.4.0

2 release files

2.3.0

2 release files

2.2.3

2 release files

2.2.2

2 release files

This release

2.2.1 This release

3 release files

2.1.3

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.5.5

2 release files

1.5.4

2 release files

1.5.3

2 release files

1.5.2

2 release files

1.4.0

2 release files

1.3.0

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.1.0

1 release file

1.0.1

1 release file

0.0.4

1 release file

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page