Pyckage Cookiecutter
Introduction
This projects consist of a cookiecutter template that generates a full structure for a creating a PyPi standard package.
While using this project, you will be asked to provide some inputs such as the author, the name of the project, etc. As result you will obtain the complete file and folder structure to quickly start to code your package.
Prerequisites
Please install the Python package cookiecutter before using it:
$ pip install cookiecutter
How to Use
Tutorial
Let’s pretend you want to create a project called “redditclone”. By using this template based on cookiecutter, you will be able to quickly setup a buildable PyPi package.
First, get cookiecutter. Trust me, it’s awesome:
$ pip install cookiecutter
Now run it against this repo:
$ cookiecutter https://github.com/zhiwei2017/pyckage-cookiecutter
You’ll be prompted for some values. Provide them, then a project will be created for you.
Warning: After this point, change ‘My Awesome Project’, ‘John Doe’, etc to your own information.
Answer the prompts with your own desired Prompts. For example:
Cloning into 'pyckage-cookiecutter'...
remote: Enumerating objects: 219, done.
remote: Counting objects: 100% (219/219), done.
remote: Compressing objects: 100% (123/123), done.
remote: Total 219 (delta 83), reused 181 (delta 69), pack-reused 0
Receiving objects: 100% (219/219), 41.09 KiB | 1.71 MiB/s, done.
Resolving deltas: 100% (83/83), done.
author [John Doe]: John Doe
email [john-doe@example.com]: john.doe@example.com
project_name [My Awesome Project]: Reddit Clone
project_slug [reddit_clone]: reddit
project_url [https://github.com/example_project]: https://github.com/reddit-clone
short_description [Behold My Awesome Project!]: A reddit clone.
version [0.1.0]: 0.1.0
Select license:
1 - MIT
2 - APACHE
3 - 2-Clause BSD
4 - 3-Clause BSD
5 - GPL
6 - None
Choose from 1, 2, 3, 4, 5, 6 [1]: 1
Select ci_tool:
1 - GitHub
2 - GitLab
3 - Bitbucket
4 - None
Choose from 1, 2, 3, 4 [1]: 1
Enter the project and take a look around:
$ cd reddit/
$ ls
Your repo should have the following structure:
reddit
├── .github - github actions configurations
│ └── workflows
│ ├── test.yml - pipelines for linting checks and testing
│ ├── release.yml - pipelines for releases with tags
│ └── sphinx.yml - pipelines for publishing github pages
├── docs - sphinx documentation
│ ├── Makefile - Makefile defines terminal commands for sphinx documentation
│ └── source - documentation source folder
│ ├── 01_about.rst
│ ├── 02_installation.rst
│ ├── 03_usage.rst
│ ├── 04_source.rst
│ ├── 05_release_notes.rst
│ ├── 06_authors.rst
│ ├── 07_contributing.rst
│ ├── conf.py - sphinx configuration file
│ └── index.rst
├── reddit
│ └── version.py - version information
├── requirements - package dependencies
│ ├── base.txt - base dependencies
│ ├── doc.txt - documentation dependencies
│ └── dev.txt - tests dependencies
├── tests - tests
│ ├── resources - resources used in tests
│ ├── conftest.py - fixtures in tests
│ └── test_version.py - test version information.
├── .gitignore
├── CONTRIBUTING.rst - contributing guidelines
├── LICENSE
├── Makefile - predefined terminal commands
├── MANIFEST.in - commands, one per line, instructing setuptools to add or remove some set of files from the sdis
├── README.rst - package information
├── setup.cfg - configurations for mypy, bandit, pytest etc. Centralizing all the configurations to one place.
├── setup.py - package installation configuration
└── tox.ini - run tests with multiple python versions
If you want to use CI/CD pipeline for uploading your package to PyPi, please check the section CI/CD configuration.
Note:
CI/CD Pipelines
The CI/CD pipelines are predefined in the generated project. Please check following sections for which steps are included and how to configure them in different platforms.
GitHub Actions
You can find all the configuration files of GitHub Actions in .github/workflows folder.
Content
Config File |
Steps |
Trigger Rules |
Requisite CI/CD Variables |
|---|---|---|---|
test.yml |
mypy check |
|
|
flake8 check |
|||
bandit check |
|||
test with python 3.6 (Ubuntu/Mac OS/Windows) |
|||
test with python 3.7 (Ubuntu/Mac OS/Windows) |
|||
test with python 3.8 (Ubuntu/Mac OS/Windows) |
|||
twine check the built package |
|||
release.yml |
deploy to PyPi |
Pushes to tags matching vXX.XX.XX |
TWINE_USERNAME |
TWINE_PASSWORD |
|||
TWINE_REPOSITORY_URL
|
|||
sphinx.yml |
deploy GitHub pages |
Pushes to master branch |
Note:
Before publishing the GitHub pages of your project for the first time, please manually create the branch gh-pages via:
$ git checkout master $ git checkout -b gh-pages $ git push origin gh-pages
Setup Steps
Go to Settings.
Click Secrets section.
Click New repository secret button.
Input the name and value of a CI/CD variable.
GitLab CI
The file .gitlab-ci.yml contains all the configurations for GitLab CI.
Content
Stages |
Steps |
Trigger Rules |
Requisite CI/CD Variables |
|---|---|---|---|
linting |
mypy check |
|
|
flake8 check |
|||
bandit check |
|||
test |
test with python 3.6 |
||
test with python 3.7 |
|||
test with python 3.8 |
|||
build |
twine check the built package |
||
deploy |
deploy to PyPi |
Pushes to tags matching vXX.XX.XX |
TWINE_USERNAME |
TWINE_PASSWORD |
|||
TWINE_REPOSITORY_URL
|
Setup Steps
Go to Settings.
Click CI/CD section.
Go to Variables section.
Click Add variable button.
Input the name and value of a CI/CD variable.
By default, the flag protected is checked, which means the added variable can only be used for protected branches/tags. If you want to keep your variable protected, please add wildcards v* as protected tags in Settings -> Repository -> Protected tags.
Or you can uncheck the box to use the variable for all branches and tags.
Bitbucket Pipelines
The file bitbucket-pipelines.yml contains all the configurations of Bitbucket Pipelines.
Content
Steps |
Trigger Rules |
Requisite CI/CD Variables |
|---|---|---|
mypy check |
|
|
flake8 check |
||
bandit check |
||
test with python 3.6 |
||
test with python 3.7 |
||
test with python 3.8 |
||
twine check the built package |
||
deploy to PyPi |
Pushes to tags matching vXX.XX.XX |
TWINE_USERNAME |
TWINE_PASSWORD |
||
TWINE_REPOSITORY_URL
|
Setup Steps
Go to Repository settings.
Click Repository variables.
Click add button.
Input the name and value of a CI/CD variable.
You need to enable pipelines before adding a new variable for the first time.
Acknowledgements
Special thanks to the project cookiecutter-pypackage for the nice CONTRIBUTING.rst template.