bootstrap/specs/poetry/template
Joshua Potter edc971fcd8 Anchor most .gitignore entries to the project root. 2023-11-28 09:21:11 -07:00
..
.githooks Wrap vars in double quotes. 2023-11-27 13:07:21 -07:00
app Demonstrate bundling a console application. 2023-11-27 20:49:55 -07:00
.envrc Add poetry spec. 2023-11-26 15:31:00 -07:00
.gitignore Anchor most .gitignore entries to the project root. 2023-11-28 09:21:11 -07:00
README.md Fix title typo. 2023-11-26 15:44:58 -07:00
default.nix Add poetry spec. 2023-11-26 15:31:00 -07:00
flake.lock Add poetry spec. 2023-11-26 15:31:00 -07:00
flake.nix Add `pname` and `version` to created app. 2023-11-28 05:52:36 -07:00
poetry.lock Add poetry spec. 2023-11-26 15:31:00 -07:00
pyproject.toml Demonstrate bundling a console application. 2023-11-27 20:49:55 -07:00

README.md

Poetry Flake Template

This is a template for constructing a working environment for Python (version 3.11.6) development. Packaging and dependency management relies on poetry (version 1.7.0). direnv can be used to a launch a dev shell upon entering this directory (refer to .envrc). Otherwise run via:

$> nix develop

Language Server

The python-lsp-server (version v1.9.0) is included in this flake, along with the python-lsp-black plugin for formatting purposes. pylsp is expected to be configured to use McCabe, pycodestyle, and pyflakes. Refer to your editor for configuration details.

Formatting

Formatting depends on the black (version 23.9.1) tool. A pre-commit hook is included in .githooks that can be used to format all *.py files prior to commit. Install via:

$> git config --local core.hooksPath .githooks/

If running direnv, this hook is installed automatically when entering the directory.