✨ Develop a Cookiecutter Template for Python Projects

[Nicoretti]

Context

To ensure all our new projects adhere to our standard Python project structure and facilitate smoother project initiation, we've decided to create a cookiecutter template. Previously, we encountered several issues (#87, #156, #157) when initiating new projects in combination with the python-toolbox. This was primarily because the python-toolbox was mainly used for our existing projects, which already complied with our basic project structure.

Steps

1. Execute the cookiecutter with the proposed template.
2. Install the project dependencies using poetry shell and poetry install.
3. Utilize the python-toolbox (tbx), to further bootstrap the workspace (for instance, setting up CI workflows). Please refer to the existing documentation for more details.

Background

Here's an outline of the repository template we're proposing:

.gitignore
.github/
.pre-commit-config.yaml
doc/
 |-_static/
 | |- light-exasol-logo.svg
 | |- dark-exasol-logo.svg
 |-changes/
 | |- changelog.md
 | |- unreleased.md
 |-conf.py
 |-index.rst
 |
exasol/
 |-<name>
    |- __init__.py
test/
 |- integration/
 |  |- conftest.py
 |  |- integration_smoke_test.py
 |-unit/
 | |- conftest.py
 | |- unit_smoke_test.py
 |-conftest.py
README.md
LICENSE
noxfile.py
noxconfig.py
pyproject.toml
error_code_config.yml

References

• Cookiecutter
• Related Issues and Discussion Threads:
  • https://github.com/exasol/python-toolbox/issues/87
  • https://github.com/exasol/python-toolbox/issues/156
  • https://github.com/exasol/python-toolbox/issues/157

Tasks

• Develop a cookiecutter template to facilitate the creation of new Python projects.
• Generate documentation to guide users in utilizing the cookiecutter template.
• Update the existing documentation to mention both the template and cookiecutter, designating this as a prerequisite for initiating new projects.