Skip to main content

Utility to create a new Python CLI

Project description


# newcli

Utility to create a new Python CLI.

## Quickstart

```bash
pipenv install newcli
newcli init
```

## Install

```bash
# Command(s)

pipenv install newcli
pip3 install --user newcli
```

## Commands

### `init`

```bash
# Command

newcli init
```

`newci` will then prompt you for basic information about your project!
The output creates this folder structure:

```bash
{{project}}/
├── LICENSE
├── MANIFEST.in
├── Pipfile
├── README.md
├── setup.py
├── tox.ini
└── {{project}}
├── __init__.py
├── __version__.py
├── cli.py
└── core.py
```

## Template CLI Project

### Testing CLI

`cd` into the directory and install to your current virtualenv

```bash
# Command
pipenv isntall -e .
```

Now run the new tool!

```
{{project}}

Usage: {{project}} [OPTIONS] COMMAND [ARGS]...

{{project}}

Options:
--help Show this message and exit.
```

Now you can begin adding new functions!

### Versioning

The project will be date versioned with as today's `YEAR.MONTH.DAY.SUBVERSION`. This handles most project updates great, and required the user to update the subversion manually in `__version__.py`.

### Publish to PyPy

- Creating a new repository on [PyPi](https://pypi.org/) is quick and easy. Quickly build and upload a new project or update an existing one with:

```bash
# Command
python setup.py upload
```

## TODO

- 100% unit tests and run on TravisCI
- populate GitHub information from .gitconfig
- init a new GitHub repository
- add .travis.yml configuration
- add template tox configuration
- add template test files and folder structure
- add template README.md
- ability to create, register, and share new templates


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

newcli-2018.6.24.3.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

newcli-2018.6.24.3-py2.py3-none-any.whl (10.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file newcli-2018.6.24.3.tar.gz.

File metadata

File hashes

Hashes for newcli-2018.6.24.3.tar.gz
Algorithm Hash digest
SHA256 e7c1310200ae3c319ba347fff0625afe722038fd45a80c995964d286d2e21d12
MD5 5a419ad2a5e4064a2c765988f097b66a
BLAKE2b-256 2472b23040971d28b9ec133778d00fb186776731254e12b11e380d28861b6339

See more details on using hashes here.

File details

Details for the file newcli-2018.6.24.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for newcli-2018.6.24.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 601ef5af675440913b9923ad5ec8c67350d01f44b18ccc87c4e11ab56e734993
MD5 fdcafbf680ec9004bca16f4505bfefb6
BLAKE2b-256 dfa692bdcf90d97c0fead82699b5673215844e703635b3667b5b6054d7b8669f

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