Skip to main content

Framework that lets you write CLIs with Typer that can also be configured via py-app-conf

Project description

PyPI PyPI - License Documentation Tests Run on Ubuntu Python Versions Tests Run on Macos Python Versions Github Repo

cliconf

Overview

Framework that lets you write CLIs with Typer that can also be configured via py-app-conf

Getting Started

Install cliconf:

pip install cliconf

A simple example:

import cliconf

# Do something with cliconf

See a more in-depth tutorial here.

Development Status

This project is currently in early-stage development. There may be breaking changes often. While the major version is 0, minor version upgrades will often have breaking changes.

Developing

First ensure that you have pipx installed, if not, install it with pip install pipx.

Then clone the repo and run npm install and pipenv sync. Run pipenv shell to use the virtual environment. Make your changes and then run nox to run formatting, linting, and tests.

Develop documentation by running nox -s docs to start up a dev server.

To run tests only, run nox -s test. You can pass additional arguments to pytest by adding them after --, e.g. nox -s test -- -k test_something.

Author

Created by Nick DeRobertis. MIT License.

Links

See the documentation here.

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

cliconf-1.0.0a12.tar.gz (19.1 kB view details)

Uploaded Source

Built Distribution

cliconf-1.0.0a12-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

Details for the file cliconf-1.0.0a12.tar.gz.

File metadata

  • Download URL: cliconf-1.0.0a12.tar.gz
  • Upload date:
  • Size: 19.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for cliconf-1.0.0a12.tar.gz
Algorithm Hash digest
SHA256 f5b748f11e529f4773deac60b22c23f2c6e26940a80baf9786aff68084de3483
MD5 5d796cc596d145c2dadf9a0021f25937
BLAKE2b-256 284a46a0878f36e279734e8e20bf70c31ca1beb4e5b3f5b72e2306c2ac5318ed

See more details on using hashes here.

File details

Details for the file cliconf-1.0.0a12-py3-none-any.whl.

File metadata

  • Download URL: cliconf-1.0.0a12-py3-none-any.whl
  • Upload date:
  • Size: 24.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for cliconf-1.0.0a12-py3-none-any.whl
Algorithm Hash digest
SHA256 f9afa24dee16af2f0708d6e64199feb278c4bcc80020639458711de3c34445be
MD5 70f04038aff081f84aa371f2bf17e693
BLAKE2b-256 c642d1b2f89be6b7864f0d4c7be9ab03a6ad1a9fe75f666ab2e757030bf4f86e

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