• update documentation
• update dependencies
• update CI
• update tests and smoke tests

ref: https://github.com/pycqa/mccabe

Add mccabe to the template as an option and if it is selected it should be added to the dependencies and to the pre-commit hook.

Add __main__ file to the template:

"""
Entrypoint module, in case you use `python -m{{cookiecutter.package_name}}`.
Why does this file exist, and why __main__? For more info, read:
- https://www.python.org/dev/peps/pep-0338/
- https://docs.python.org/2/using/cmdline.html#cmdoption-m
- https://docs.python.org/3/using/cmdline.html#cmdoption-m
"""
{%- if cookiecutter.command_line_interface == 'plain' %}
import sys
{% endif %}
from {{cookiecutter.package_name}}.cli import main

if __name__ == "__main__":
{%- if cookiecutter.command_line_interface == 'plain' %}
    sys.exit(main())
{%- else %}
    main()
{%- endif %}

PS: thanks to @jloehel for all this input

• #15
• #4
• #16

in the semantic release github action workflow, allow it for push and for pull_request, exemplo:

on:
  workflow_dispatch:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

The current step for semantic release command should be executed just for workflow dispatch:

if: ${{ github.event_name == 'workflow_dispatch' }}

Additionally, before this step, we should add a copy of the semantic release step, but just for non workflow dispatch event:

if: ${{ github.event_name != 'workflow_dispatch' }}

this step should run for --dry instead of --ci

see: osl-pocs/poc-semantic-release#2

Add API documentation for:

• mkdocs
• #173
• #174
• #175

ref: http://www.pydocstyle.org/en/stable/

add pydocstyle as an option to the template, if it is selected it should be added as a dependency (dev) and should be included to the pre-commit hook

Add an option for governance document, called governance_document_based_on, with the following options:

• NumPy governance document
• SciML governance document
• None

Currently ,the semantic release step doesn't have a name
it would be nice to have the following name: "Run semantic release command"

ref https://github.com/osl-incubator/cookiecutter-python/blob/main/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/release.yaml#L14

it seems that ruff is a great alternative for flake8: https://github.com/charliermarsh/ruff

Probably we can resolve this using post generation hook: https://github.com/osl-incubator/cookiecutter-python/blob/main/hooks/post_gen_project.py

Description

Currently, cookiecutter-python only has a bug report template, which is also the default template. The templates can be updated to include feature requests, documentation issues, and so on. Additionally, we can switch to form-based issues (YAML-based issue templates) for more user-friendliness.

For reference, I really like pyhf's issue templates - https://github.com/scikit-hep/pyhf/tree/main/.github/ISSUE_TEMPLATE

ref: https://bandit.readthedocs.io/en/latest/start.html

Add bandit to the template as an option and if it is selected it should be added to the dependencies and to the pre-commit hook.

• check if poetry is working correctlly

Currently, if there is already any commit on the origin/upstream main branch .. the branch created by the cookiecutter will have conflicts when we want to open a PR.

Additionally maybe it is too verbose to add the info for upstream and origin https urls
we probably should use a different approach

ref: https://github.com/thegraphnetwork/epigraphhub_py/blob/main/.pre-commit-config.yaml#L41

Currently, the template generates a github actions workflow with mamba-version: "0.23.0"
that is old and also it is breaking the ci. this should be removed

• black
• flake8
• isort
• mypy
• fix-end-of-file

ref: https://github.com/actions/checkout

We need to revisit the dependencies used inside the template and update them.
probably we can remove the "cookiecutter" deps used inside the template

ref: https://hypothesis.readthedocs.io/en/latest/

maybe 2 examples would be nice, so we can decide which one we want to use.

currently, we are using black as a auto-format tool.
it would be good to have another option for that: blue

so we could have a variable called auto_format_tool and have 2 options (for now): black and blue

Add an option called "build_system" with the options:

• poetry (default)
• #53
• #54
• #55
• #32
• #69
• #70
• #71
• #72

ideally if sphinx is selected, it should show an option for source format md or rst

• mkdocs (1)
• sphinx_and_readthedocs (2)
• jupyter_book (3)
• test all the 3 documentation options

Add an option called add_containers with options: None, Docker and Podman

Currently, the template generates a github actions workflow with mamba-version: "0.23.0"
that is old and also it is breaking the ci. this should be removed

Description

ruff is extremely fast and is now being adopted widely by scientific packages. With the migration, we will be able to get rid of isort and flake8-pyproject from pre-commit-config.yaml.

Additionally, ruff can also automatically fix the captured errors, which can be an advantage when using pre-commit.ci (see #62 (comment)).

Add semantic release to cookiecutter-python

reference: https://github.com/osl-incubator/poc-semantic-release/

basically it should have:

• https://github.com/osl-incubator/poc-semantic-release/blob/main/.releaserc.json
• nodejs: https://github.com/osl-incubator/poc-semantic-release/blob/main/conda/dev.yaml#L16
• release from a ci-workflow: https://github.com/osl-incubator/poc-semantic-release/blob/main/.github/workflows/release.yaml#L41
  • but instead for doing that on push (https://github.com/osl-incubator/poc-semantic-release/blob/main/.github/workflows/release.yaml#L3), do it on workflow dispatch https://github.com/ibis-project/ibis/blob/master/.github/workflows/release.yml#L4

Add an option for code of conduct to the template.
This option should allow 3 answers:

1. None
2. Contributor Covenant (Recommended for projects of all sizes)
3. Citizen Code Of Conduct (Suitable for large communities and events)

In the past, we needed to use bash -l {0} in order to activate the conda environment from setup-miniconda action,
but now is not necessary and we can use it with:

    defaults:
      run:
        shell: bash -l {0}

ref: https://github.com/thegraphnetwork/epigraphhub_py/blob/main/.github/workflows/release.yaml#L9

We need to update it for all the github actions workflow we are generating

Move release step from main.yaml: https://github.com/osl-incubator/cookiecutter-python/blob/main/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/main.yaml#L40

to a new workflow called release.yaml, triggered by workflow dispatch. example: https://github.com/ibis-project/ibis/blob/master/.github/workflows/release.yml#L4

Improve tests on CI:

• test all options when creating a NEW project from template
• test semantic release for the NEW project from template
• test semantic release for cookiecutter-python

A time out mechanism is really import to prevent a job to be running with no limits and consuming all the time available we have on CI.

we need to add timeout_minutes: 10 to all the githuab actions workflow file we are generating from our template.

ref: https://github.com/arxlang/arx/blob/main/.github/workflows/release.yaml#L17

https://github.com/osl-incubator/cookiecutter-python/blob/main/%7B%7Bcookiecutter.project_slug%7D%7D/pyproject.toml#L1

Description

Currently, we just use poetry as build-system and dependency manager, we need to have an option on our template ir order to allow poetry (the default) and pdm.

Details

Basically, we need to add a new option to our template, called build-system with 2 options "poetry" and "pdm", the default is the first one (poetry).

for poetry we can use the current configuration.
for pdm it should not use any configuration from poetry and should add the specific configurations for pdm in the pyproject.toml and also add the correspondent dependencies on the conda env file.

NOTE: no changes is necessary in the root of the project (it should keep using poetry), the changes about poetry and pdm is just inside the template

refs:

• https://pdm.fming.dev/latest/
• https://henryiii.github.io/level-up-your-python/notebooks/2.7%20Creating%20Packages.html#

Currently , the semantic release replace plugin configuration is not matching the correct pattern for the version replacement.

in this PR, there is something similar to what should be updated here in the template:
https://github.com/osl-incubator/containers-sugar/pull/7/files

Our template should publish the documentation to the github actions in the release workflow

ref: https://github.com/arxlang/arx/blob/main/.github/workflows/release.yaml#L62-L72

Add to the semantic release pipeline a step for publishing to pypi

ref: https://github.com/thegraphnetwork/epigraphhub_py/blob/main/.releaserc.json#L59

example:

<!-- Describe what this PR aims to resolve. E.g. This PR aims to ...  -->

<!-- Which issue this PR aims to resolve or fix. E.g. This PR resolves #... -->

## How to test these changes

<!-- Example:

* run the command `abc d`
* open the web browser with url localhost
* ...
-->

* ...

## Author's Checklist

- [ ] it includes tests
- [ ] the tests are executed on CI.
- [ ] it includes documentation
- [ ] pre-commit hooks were executed locally
- [ ] Filled the section "How to test these changes" with detailed instructions.

## Additional information

<!-- Add any screenshot that helps to show the changes proposed -->

<!-- Add any other extra information that would help to understand the changes proposed by the PR -->

## Reviewer's Checklist

Copy and paste this template for your review's note:

```
## Reviewer's Checklist

- [ ] I managed to reproduce the problem locally from the `main` branch
- [ ] I managed to test the new changes locally
- [ ] I confirm that the issues mentioned were fixed/resolved .
```

example:

- name: Run style checks
  if: success() || failure()
  run: pre-commit run --all

ref: https://github.com/jendrikseipp/vulture

Add vulture as an option to the template and if it is selected it should be added as a dependency (dev) and pre-commit hook