Skip to content

Releases: boromir674/cookiecutter-python-package

v1.5.0

11 Jun 17:21

Choose a tag to compare

This release focused on improving the code architecture, reducing technical
debt, decoupling components, cleaning code, fixing styling issues.

It also features some updates in the Generated Project, with improved tox envs,
cleaner python scripts and cleaner development tools' configuration files
(such as .pylintrc, pyproject.toml, tox.ini).

Changes
^^^^^^^

feature
"""""""

  • document config settings, improve tox envs & scripts

test
""""

  • verify Generator can be invoked as python module: python -m cookiecutter_python

refactor
""""""""

  • dry code per string_sanitizer implementation
  • reduce code in cli.py by delegating error handling to the new cli_handlers.py module
  • reduce code of parse_version.py script
  • abstract input sanitization
  • reduce main code
  • decouple components
  • clean code, satisfy some todos, dry code

ci
""

  • use the template's parse_version script to reduce duplicate code

v1.4.1

07 Jun 15:20

Choose a tag to compare

What's Changed

Full Changelog: v1.4.0...v1.4.1

v1.4.0

06 Jun 18:07

Choose a tag to compare

Add a CLI as an entrypoint to your Python Package

This release enables the user to optionally provide their Python Package with
a Command Line Interface (CLI) as an entrypoint.
The add_cli Generator Variable has been added to behave as an enable/disable
'switch'.

v1.3.0

01 Jun 16:03

Choose a tag to compare

Python Interpreters Support and Test

This release allows the user to select the Python Interpreters they wish their Project
to support and be tested on.
The generator then creates the Test Matrix in the CI config file, which factors in the
Python Interpreter versions supplied by the user.

Consistent with the currect behaviour of the cli, passing the '--no-input' flag,
instructs the Generator to try find the selected interpreters in a config yaml file,
if given, or else to use the information in the cookiecutter.json.

If the '--no-input' flag is missing, then the user is asked for input, through
their console.
The input is read by supplying an interactive console dialog, which allows the user to
easily select the interpreters they wish to support, by enabling or disabling
'check boxes' through their console.

Development

All tox environments related to 'Linting' now all do by default a 'check'.
Doing a 'check' means returning a 0 as exit code in case the check is successfull
and it is suitable for local and remote running on a CI server.

The aforementioned environments are 'lint', 'black', 'isort':

  • tox -e lint
  • tox -e black
  • tox -e isort

Optionally, running as below will modify the source code to comply with
each respective 'lint check'.

Running environment 'lint', 'black', 'isort' with 'lint apply' enabled:

  • APPLY_LINT= tox -e lint
  • APPLY_BLACK= tox -e black
  • APPLY_ISORT= tox -e isort

v1.2.1

27 May 03:31

Choose a tag to compare

What's Changed

Full Changelog: v1.2.0...v1.2.1

v1.2.0

24 May 17:24

Choose a tag to compare

Changes
^^^^^^^

feature
"""""""

  • migrate to poetry from setuptools as 'build-backend'

fix
"""

  • add rule in MANIFEST to match tox.ini similar to *.md, etc non-python files
  • replace hardcoded values with templated variables

test
""""

  • sanity check to double check that 'tox.ini' gets put in generated dir

documentation
"""""""""""""

  • rewrite module docstring

ci
""

  • use checkout@v3 instead of @v1
  • upload sdist & wheel as artefacts
  • separate codecov data exchange into dedicated job

Cookiecutter Python Package v1.1.1

17 May 15:50

Choose a tag to compare

Installation Guide & CLI Usage

Changes

documentation

  • document installation and cli usage

Cookiecutter Python Package v1.0.0

17 May 01:32

Choose a tag to compare

Python Generator CLI & Async

Wrapping everything in a command line interface (cli).
Speed up performance by using futures for http requests.

Cookiecutter Python Package v1.0.0

11 May 17:53

Choose a tag to compare

Cookiecutter Python Package v1.0

First v1.* Release

Releasing v1.0.0, the first ever v1.* version!
We are confident that the user-facing "interface" of this package is stable
and commit to (continue to) follow Semantic Versioning.

As far as changes are concerned, invoking the project generator
now adds several new status badges in your README, which automatically update based on
their corresponding CI services!

Cookiecutter Python Package v0.11.0

11 May 16:28
3e47993

Choose a tag to compare

Documentation Website Generation

Project Generation now includes build a completely functional website that initially hosts some minimum content.

The website can be publicly hosted, if you create a free account on readthedocs.org and make a few simple configurations
through the web ui.