drkostas / starter

A starter template for Python packages

Starter

Table of Contents

• About
• Getting Started
  • Prerequisites
• Installing
• Todo
• Built With
• License
• Acknowledgments

About

A cookiecutter template for Python packages.

Getting Started

These instructions will help you generate a new python project/package from the cookiecutter template.

There are 2 ways to use this template:

1. Just open a command line and run:

cookiecutter https://github.com/drkostas/starter.git

You have to have cookiecutter installed first of course. If you don't, run: pip install cookiecutter~=1.7.2 first

2. Clone this repository and follow the next steps

Prerequisites

You need to have a machine with Python > 3.6 and any Bash based shell (e.g. zsh) installed.

$ python3.8 -V
Python 3.8.5

$ echo $SHELL
/usr/bin/zsh

Installing

All the installation steps are being handled by the Makefile.

Just execute the following command and fill in the project variables that will be requested:

$ make install

To delete the cookiecutter directory run:

$ make clean

TODO

Read the TODO to see the current task list.

Built With

• Cookie - A command-line utility that creates projects from cookiecutters (project templates)

License

This project is licensed under the Apache License - see the LICENSE file for details.

Acknowledgments

• Thanks to PurpleBooth for the README template