radix-ai/poetry-cookiecutter

🍪 Poetry Cookiecutter is a modern Cookiecutter template for scaffolding Python packages and apps

poetry-cookiecutter's Issues

Build stage in GitLab CI/CD runs two jobs in parallel

Consider adding nbQA to lint Jupyter notebooks (if selected)

https://github.com/nbQA-dev/nbQA

Add to README that cookiecutter 2.1.1 is required (1.7.x is broken)

Use Cookiecutter's boolean variables once Cruft supports them

See https://cookiecutter.readthedocs.io/en/latest/advanced/boolean_variables.html.

Add meta pre-commit hooks

https://pre-commit.com/#meta-hooks

Add `black[jupyter]` to format notebooks if Jupyter is selected

https://github.com/psf/black#installation

Enable zsh history

With:

HISTFILE=~/.zsh_history
HISTSIZE=1000
SAVEHIST=1000

Use Cookiecutter's private variables to render commonly used expressions

See https://cookiecutter.readthedocs.io/en/latest/advanced/private_variables.html.

Make docstring format (`numpy`, `google`, ...) configurable

Evaluate adding diff-cover to automatically require added/changed lines to be covered

Considerations:

1. Is requiring 100% coverage on added/changed lines too strict? Maybe we should go for 50% by default and leave it up to the user to set it higher if they wish.
2. The tool works by comparing against a remote branch like origin/main (the default), which needs to be configured in pyproject.toml. What happens is that branch doesn't exist? Is there a way we can figure this out from Cookiecutter?

https://github.com/Bachmann1234/diff_cover

Automatically change port mapping if PORT 8000 is already used

When working on several poetry cookie cutter projects (and/or with other apps that use port 8000), the devcontainer won't work because the port 8000 is already used by those other projects/apps.

Simply manually setting a different port in the docker-compose.yml and pyproject.toml for each of the projects does the trick.

But it would be nice to have something like what jupyter notebook and lab do. I.e. trying their default port number, and using another one if the first one is already used, and another one if the second one is already in use, etc.
WDYT?

Improve README so `cruft create` creates files in cloned repository

Remove macOS-specific section on Nerd Fonts from README

Add typeguard's pytest plugin for run time type checking of tests

https://typeguard.readthedocs.io/en/latest/userguide.html#using-the-pytest-plugin

Add `poetry lock --check` to the pre-commit config after Poetry 1.2.0 is integrated

To verify that the poetry.lock is in sync with pyproject.toml. See python-poetry/poetry#1954.

`secrets` in docker-compose wrong indentation

It appears the secrets: in the dockercompose file in the app:build and dev:build is overindented

Possibly run pre-commit automatically after merge but before merge commit

https://pre-commit.com/#pre-commit-during-clean-merges

Benefit from image caching in CI/CD

Replace the Dev Container CLI with the Dev Container GitHub Action once devcontainers/ci#148 is resolved to benefit from image caching.

Investigate why pre-commit hooks need installation on first container startup

Add absolufy-imports to pre-commit hooks

https://github.com/MarcoGorelli/absolufy-imports

Set black's `target-version` to `cookiecutter.python_version`

target-version will be treated as the minimum version in the future: psf/black#751 (comment)

Evaluate adding `codespell` as a pre-commit linter

https://til.simonwillison.net/python/codespell

Provide a Codespace dev container for Poetry Cookiecutter itself

Including Conventional Commit linting.

Why use pydantic's mypy plugin with typer?

Pydantic is a library to handle data validation using standard modern Python type annotations.
It powers FastAPI underneath.
It is not used by Typer, but it inspired a lot of the design (through FastAPI).¹

It also does not support models.²

Footnotes

1. Reference ↩

2. Reference ↩

Handle conditional files in `post_gen_project.py`

1. We currently only handle conditional directories in post_gen_project.sh.
2. We should handle conditional files in post_gen_project as well because % is not a supported filepath character on Windows.
3. We should not assume that bash is available [1]:

For portability, you should use Python scripts (with extension .py) for your hooks, as these can be run on any platform.

[1] https://cookiecutter.readthedocs.io/en/latest/advanced/hooks.html#using-pre-post-generate-hooks

Upgrade from Python 3.8 to Python 3.10 once the ecosystem is mature enough

• Include pyupgrade settings
• Make Python version a configurable choice?
• https://pyreadiness.org/3.10/

Unable to scaffold repo with default arguments

Short description:

When scaffolding a newly created GitLab repo via the command "cruft create -f [email protected]:radix-ai/poetry-cookiecutter.git", it fails with the following error (full error stack below):
FileNotFoundError: [Errno 2] No such file or directory: '<local_path>/{{ cookiecutter.package_name|slugify }}/tests/test_sentry.py'

Steps to reproduce:

• Create a new GitLab repo
• Clone it locally
• Scaffold it via the cruft create -f [email protected]:radix-ai/poetry-cookiecutter.git => you get the error.

Full logs / error message:

(base) ➜ VLAIO_HSCO cruft create -f [email protected]:radix-ai/poetry-cookiecutter.git

package_name [My Package]: HSCO
package_description [A Python package that ...]:
package_url [https://github.com/user/my-package]:
author_name [John Smith]:
author_email [[email protected]]:
python_version [3.8]:
with_fastapi_api [0]:
with_jupyter_lab [0]:
with_pydantic_typing [0]:
with_sentry_logging [0]:
with_streamlit_app [0]:
with_typer_cli [0]:
Select continuous_integration:
1 - GitHub
2 - GitLab
Choose from 1, 2 [1]: 2
Select docstring_style:
1 - NumPy
2 - Google
Choose from 1, 2 [1]:
private_package_repository_name []:
private_package_repository_url []:
Traceback (most recent call last):
File "/usr/local/bin/cruft", line 8, in
sys.exit(app())
File "/usr/local/Cellar/cruft/2.10.2/libexec/lib/python3.10/site-packages/typer/main.py", line 214, in call
return get_command(self)(*args, **kwargs)
File "/usr/local/Cellar/cruft/2.10.2/libexec/lib/python3.10/site-packages/click/core.py", line 1130, in call
return self.main(*args, **kwargs)
File "/usr/local/Cellar/cruft/2.10.2/libexec/lib/python3.10/site-packages/click/core.py", line 1055, in main
rv = self.invoke(ctx)
File "/usr/local/Cellar/cruft/2.10.2/libexec/lib/python3.10/site-packages/click/core.py", line 1657, in invoke
return _process_result(sub_ctx.command.invoke(sub_ctx))
File "/usr/local/Cellar/cruft/2.10.2/libexec/lib/python3.10/site-packages/click/core.py", line 1404, in invoke
return ctx.invoke(self.callback, **ctx.params)
File "/usr/local/Cellar/cruft/2.10.2/libexec/lib/python3.10/site-packages/click/core.py", line 760, in invoke
return __callback(*args, **kwargs)
File "/usr/local/Cellar/cruft/2.10.2/libexec/lib/python3.10/site-packages/typer/main.py", line 500, in wrapper
return callback(**use_params) # type: ignore
File "/usr/local/Cellar/cruft/2.10.2/libexec/lib/python3.10/site-packages/cruft/_cli.py", line 107, in create
_commands.create(
File "/usr/local/Cellar/cruft/2.10.2/libexec/lib/python3.10/site-packages/cruft/_commands/utils/init.py", line 14, in wrapper
return f(*args, **kwargs)
File "/usr/local/Cellar/cruft/2.10.2/libexec/lib/python3.10/site-packages/cruft/_commands/create.py", line 46, in create
generate_files(
File "/usr/local/Cellar/cruft/2.10.2/libexec/lib/python3.10/site-packages/cookiecutter/generate.py", line 352, in generate_files
generate_file(
File "/usr/local/Cellar/cruft/2.10.2/libexec/lib/python3.10/site-packages/cookiecutter/generate.py", line 179, in generate_file
with io.open(outfile, 'w', encoding='utf-8') as fh:
FileNotFoundError: [Errno 2] No such file or directory: '/{{ cookiecutter.package_name|slugify }}/tests/test_sentry.py'

Add `E203` and `W503` to `ruff` ignores when available

Specify the `remoteUser` to automatically set the right UID and GID

https://code.visualstudio.com/remote/advancedcontainers/add-nonroot-user#_specifying-a-user-for-vs-code

Add yesqa to pre-commit

https://github.com/asottile/yesqa

The `chown` step in `Dockerfile` is expensive because it creates a new layer

Should be removed.

Replace zsh-antigen with zsh-antidote

Antigen is not actively maintained anymore. Antidote seems like it's the best actively maintained successor.

`python-no-eval` hook generates false positives when using torch

pre-commit/pygrep-hooks#128

Remove redundant volume mounts

If one image extends another, the volumes get extended as well. Hence, there's a redundant .:/app/ mount in dev found in the docker-compose.yml.

`dev` service should not start when Dev Container starts

Problem: when the Dev Container starts, all services in docker-compose.yml are started, while not all of them are necessary (e.g. the app service).

Solution: add a profile to avoid this. Services with a profile won't automatically be started by docker compose up.

Relevant VS Code issue: microsoft/vscode-remote-release#6188

Run failed tests first with `--failed-first` to improve test workflow

https://docs.pytest.org/en/latest/how-to/cache.html

Loosen Poetry’s patch version

Remove `absolufy-imports` once integrated in `ruff`

astral-sh/ruff#1014

Consider adding `zsh-autocomplete`

https://github.com/marlonrichert/zsh-autocomplete

Add support for GnuPG to enable verified commits

Clarify Dev Containter workflow for multiple Terminals

Workflow:

1. docker compose up --detach dev
2. docker compose exec dev zsh
3. docker compose stop dev

CC @RubenPants

Adding Terraform to Azure App Service setup

For the Darts demo, Tanguy added code to Terraform the app through the Gitlab CI/CD.

Would it be valuable to have an Azure App Service Terraform setup included in Cookiecutter (maybe as an optional choice when initializing a new project)? I see a lot of value in having an automated way to deploy e.g. Streamlit apps to App Service, but maybe it’s too much, wdyt?

Add `darglint` once integrated in `ruff`

astral-sh/ruff#458

Use pre-commit `args:` instead of inlining them under `entry:`

https://pre-commit.com/#arguments-pattern-in-hooks

Upgrade to Poetry 1.2 once it's stable

• Differentiate between dev and test dependencies
• Review plugin ecosystem that comes with Poetry 1.2 (e.g. Poe)

Make Python version a build arg, test matrix

Gitlab SSH key: permission denied from within dev container

Description

When inside a dev-container, it is not possible to push/pull/communicate with Gitlab until the command "ssh-add ~/.ssh/<your_key>" (e.g. ssh-add ~/.ssh/id_rsa) is performed: we get "Permission denied" without the possibility to enter a passphrase. For example:

⬢ [Docker] ❯ ssh -T [email protected]
[email protected]: Permission denied (publickey,keyboard-interactive).

Outside the dev container, even without doing the command "ssh-add ~/.ssh/<your_key>", it is possible to interact with Gitlab but the passphrase is required every time. For example:

(base) raphaelpeschi@Raphaels-MBP or-tools-test % ssh -T [email protected]
Enter passphrase for key '/Users/raphaelpeschi/.ssh/id_rsa':
Welcome to GitLab, @Raphael85!

Reproduction

• Given a SSH key for Gitlab that requires a passphrase
• Reboot your laptop
• Using VSCode, open a project using poetry-cookiecutter (it will automatically be inside the dev container)
• Perform the command "ssh -T [email protected]": the following results is obtained:

root in app on  main [!] is 📦 v0.0.0 via 🐍 v3.8.12
⬢ [Docker] ❯ ssh -T [email protected]
[email protected]: Permission denied (publickey,keyboard-interactive).

Workarounds

Method 1) Push/pull from outside the container (e.g. open a new terminal outside VSCode)

Method 2) After each laptop reboot, perform the command "ssh-add ~/.ssh/<your_key>" outside the dev container. This will allow to interact with Gitlab without entering the passphrase, both outside and within dev containers.

Better `.zsh_history` persistence

Problem: rebuilding the Dev Container means you lose your shell history right now.

Document cookiecutter.json parameters

Evaluate replacing `flake8` with `ruff`

https://github.com/charliermarsh/ruff

Checklist (last updated 2022-11-18):

• ✅ bandit
• ❌ darglint
• 🦺 flake8 (missing Python 3.9 and 3.10 language features)
• 🦺 flake8-bugbear (25/32)
• ✅ flake8-comprehensions
• ❌ flake8-mutable
• ✅ flake8-print
• ✅ Flake8-pyproject
• ❌ flake8-pytest-style
• ❌ flake8-rst-docstrings
• 🦺 flake8-tidy-imports (1/3)
• ✅ pep8-naming
• ✅ pydocstyle
• 🦺 pyupgrade (13/33)
• ✅ yesqa