https://github.com/nickderobertis/cliconf

Framework that lets you write CLIs with Typer that can also be configured via py-app-conf
https://github.com/nickderobertis/cliconf

Last synced: about 3 hours ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/nickderobertis/cliconf
• Owner: nickderobertis
• License: mit
• Created: 2022-06-12T18:46:56.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-04T10:11:55.000Z (over 2 years ago)
• Last Synced: 2024-12-25T01:34:28.144Z (about 1 month ago)
• Language: Python
• Size: 1.16 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


[![](https://codecov.io/gh/nickderobertis/py-cli-conf/branch/main/graph/badge.svg)](https://codecov.io/gh/nickderobertis/py-cli-conf)

[![PyPI](https://img.shields.io/pypi/v/py-cli-conf)](https://pypi.org/project/py-cli-conf/)

![PyPI - License](https://img.shields.io/pypi/l/py-cli-conf)

[![Documentation](https://img.shields.io/badge/documentation-pass-green)](https://nickderobertis.github.io/py-cli-conf/)

![Tests Run on Ubuntu Python Versions](https://img.shields.io/badge/Tests%20Ubuntu%2FPython-3.8%20%7C%203.9%20%7C%203.10-blue)

![Tests Run on Macos Python Versions](https://img.shields.io/badge/Tests%20Macos%2FPython-3.8%20%7C%203.9%20%7C%203.10-blue)

[![Github Repo](https://img.shields.io/badge/repo-github-informational)](https://github.com/nickderobertis/py-cli-conf/)

#  py-cli-conf

## Overview

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

## Getting Started

Install `py-cli-conf`:

```

pip install py-cli-conf

```

A simple example:

```python

import pycliconf

# Do something with pycliconf

```

See a

[more in-depth tutorial here.](

https://nickderobertis.github.io/py-cli-conf/tutorial.html

)

## 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.](

https://nickderobertis.github.io/py-cli-conf/

)