Faster package development with templates

Developing Python Packages

James Fulton

Climate informatics researcher

Templates

Python packages have lots of extra files
There is a lot to remember
Using templates takes care of a lot of this

Package file tree

.
|-- example_package
|   |-- __init__.py
|   `-- example_package.py
|-- tests
|   |-- __init__.py
|   `-- test_example_package.py
|-- README.rst     <-
|-- LICENSE        <-- lots
|-- MANIFEST.in    <-- of
|-- tox.ini        <-- additional
|-- setup.py       <-- files
`-- setup.cfg      <--

cookiecutter

Can be used to create empty Python packages
Creates all the additional files your package needs

Package file tree

.
|-- example_package
|   |-- __init__.py
|   `-- example_package.py
|-- tests
|   |-- __init__.py
|   `-- test_example_package.py
|-- README.rst
|-- LICENSE
|-- MANIFEST.in
|-- tox.ini
|-- setup.py
`-- setup.cfg

Using cookiecutter

cookiecutter <template-url>

Using cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

More templates here

Using cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

full_name [Audrey Roy Greenfeld]:

Using cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

full_name [Audrey Roy Greenfeld]: James Fulton

Fill in your name and press enter/return to continue

Using cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

full_name [Audrey Roy Greenfeld]: James Fulton

email [[email protected]]: [email protected]                  
github_username [audreyr]:  MyUsername

project_name [Python Boilerplate]: mysklearn
project_slug [mysklearn]: mysklearn

Project slug - the name used in pip install name

Using cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

...
project_short_description [Python Boilerplate ...]: A Python package for linear 
    regression.

pypi_username [MyUsername]: 
version [0.1.0]:

Using cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

...
use_pytest [n]: y
use_pypi_deployment_with_travis [y]: n
add_pyup_badge [n]: n

Using cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

...
Select command_line_interface:
1 - Click
2 - Argparse
3 - No command-line interface
Choose from 1, 2, 3 [1]: 3

create_author_file [y]: y

Using cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

...
Select open_source_license:
1 - MIT license
2 - BSD license
3 - ISC license
4 - Apache Software License 2.0
5 - GNU General Public License v3
6 - Not open source
Choose from 1, 2, 3, 4, 5, 6 [1]: 6

Template output

mysklearn/
|-- mysklearn/
|   |-- __init__.py
|   `-- mysklearn.py
|-- tests/
|   |-- __init__.py
|   `-- test_mysklearn.py
|-- MANIFEST.in
|-- README.rst
|-- requirements_dev.txt
|-- setup.cfg
|-- setup.py
|-- tox.ini

|-- AUTHORS.rst
|-- CONTRIBUTING.rst
|-- HISTORY.rst
`-- Makefile

Inside the AUTHORS.rst file

=======
Credits
=======

Development Lead
________________

* James Fulton <[email protected]>

Contributors
____________

None yet. Why not be the first?

Template output

mysklearn/
|-- mysklearn/
|-- tests/
|-- MANIFEST.in
|-- README.rst
|-- requirements_dev.txt
|-- setup.cfg
|-- setup.py
|-- tox.ini
...
...
|-- docs/
|-- .github/
|-- .editorconfig
|-- .gitignore
`-- .travis.yml

Let's practice!

Developing Python Packages