Pyckage-Cookiecutter 1.0.2

Tutorial

Let’s pretend you want to create a project called “feddit”. 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

or with poetry:

$ poetry self add cookiecutter

Now run it against this repo:

$ cookiecutter https://github.com/zhiwei2017/pyckage-cookiecutter

or:

$ poetry run 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.
  [1/8] Select your project name (My Awesome Project):
  [2/8] Project URL for hosting the source code. (https://repository-hosting.com/example_project): https://github.com/zhiwei2017/feddit
  [3/8] Author full name. (John Doe): John Doe
  [4/8] Author email address. (john.doe@email.com): john.doe@example.com
  [5/8] Short description. (Behold My Awesome Project!): A fake reddit API.
  [6/8] Semantic version to use for release. (0.1.0): 0.1.0
  [7/8] Which license do you want to use for your project?
    1 - None
    2 - MIT
    3 - APACHE
    4 - 2-Clause BSD
    5 - 3-Clause BSD
    6 - GPL
    Choose from [1/2/3/4/5/6] (1): 2
  [8/8] Which CI/CD pipelines do you plan to use?
    1 - None
    2 - GitHub
    3 - GitLab
    4 - Bitbucket
    Choose from [1/2/3/4] (1): 2
**Please read the comments from README.rst in your project to get to know how to setup the CI/CD pipeline and use commands from Makefile.**

Enter the project and take a look around:

$ cd feddit/
$ ls

Your repo should have the following structure:

feddit
├── .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_source.rst
│       ├── 03_authors.rst
│       ├── 04_contributing.rst
│       ├── conf.py                 - sphinx configuration file
│       └── index.rst
├── feddit
│   └── __init__.py
├── 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 flake8, since it doesn't support pyproject.toml.
└── pyproject.toml                  - package configuration file

If you want to use CI/CD pipeline for uploading your package to PyPi, please check the section CI/CD configuration.

Note:

• This repo is built as a wheel package and uploaded to PyPi. You can install it through pip:

  $ pip install pyckage-cookiecutter

  or through poetry:

  $ poetry self add pyckage-cookiecutter

  And start generating a new project by call:

  $ pyckage_cookiecutter

  or:

  $ poetry run pyckage_cookiecutter

  The rest is the same as the Tutorial introduced.

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.

Makefile