Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/seanluong/cookiecutter-python-cli

A cookiecutter template for creating a Python CLI application using click
https://github.com/seanluong/cookiecutter-python-cli

cookiecutter cookiecutter-template python

Last synced: about 1 month ago
JSON representation

A cookiecutter template for creating a Python CLI application using click

Awesome Lists containing this project

README

        

# Python CLI Application Template

[![Build Status](https://travis-ci.org/xuanluong/cookiecutter-python-cli.svg?branch=master)](https://travis-ci.org/xuanluong/cookiecutter-python-cli)

This is a [cookiecutter](https://github.com/audreyr/cookiecutter) template for generating
a Python command-line interface (CLI) application.

# Features

- [pytest](https://github.com/pytest-dev/pytest/) to run tests
- [click](https://github.com/pallets/click) to facilitate building a CLI application
(parsing and handling commands, arguments, options, etc.)
- `yml` file for [Travis](http://travis-ci.org/) CI
- Different choices of open source license

# Usage

- Install the requirements
```
pip install -r requirements.txt
```
- Generate project starting code
```
cookiecutter https://github.com/xuanluong/cookiecutter-python-cli
```
or
```
python -m cookiecutter https://github.com/xuanluong/cookiecutter-python-cli
```

# Contributing

Contributors are always welcome! There's no contributing guideline yet.
Feel free to raise an issue or submit a PR.