CiscoSE/cc-pyscript

Cookiecutter template for a Python script.

Python Script | Cookiecutter Project Template

Cookiecutter template for a Python script.

This Cookiecutter project template makes it easy for you to start a Cisco Sample Code project to create and share an executable Python Script.

Motivation

Creating a Python script is easy. Sharing one, with the needed licensing and essential documentation, should also be easy.

Show Me!

$ cookiecutter cc-pyscript
full_name [John Doe]:
email [jdoe@cisco.com]:
project_name [Python Script]: Rainbow Unicorn
project_slug [rainbow_unicorn]:
project_short_description [Cisco Sample Code Python Script]: Does cool stuff
version [0.1.0]:
use_click [y]:

$ tree -a rainbow_unicorn/
rainbow_unicorn/
├── .github
│   ├── ISSUE_TEMPLATE
│   │   ├── bug_report.md
│   │   └── feature_request.md
│   └── PULL_REQUEST_TEMPLATE.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── rainbow_unicorn.py
└── requirements.txt

2 directories, 9 files

Features

• Cisco Sample Code License and code headers
• README template for Cisco sample code projects
• GitHub recommended docs and templates
• Command line interface using Click (optional)

Using this Project Template

The First Time

$ cookiecutter https://github.com/CiscoSE/cc-pyscript

...or using abbreviated syntax:

$ cookiecutter gh:CiscoSE/cc-pyscript

Thereafter

$ cookiecutter cc-pyscript

Installation

Install the latest Cookiecutter if you haven't installed it yet:

pip install -U cookiecutter

If you need a bit more help, see Installation in the Cookiecutter docs.

Credits

The following resources were influencial in the creation of this project:

• Cookiecutter by Audrey Roy Greenfeld (@audreyr)

Who is this for?

This project template is for use by Cisco Systems Engineers who are creating example and demonstration code (aka. Cisco Sample Code) and sharing it with Cisco's customers and partners for use with Cisco products and services. The Cisco Sample Code License is for use in Cisco Repositories Only. It is not an Open Source license. The license should only be used by Cisco and/or its affiliates to post and share Cisco Sample Code.