Create a skeleton python project and modify it to fit this project

Create a skeleton python project using "hatch new -i --cli
infra-rebuild" with Hatch version 1.7.0 and modify it to fit this
project. This is the first step of porting infra-rebuild to Python.

Also provide a first .gitignore ignoring relevant build directories.
This commit is contained in:
June 2024-06-05 15:24:47 +02:00
parent d085cfd3b9
commit 500438636a
Signed by: june
SSH key fingerprint: SHA256:o9EAq4Y9N9K0pBQeBTqhSDrND5E7oB+60ZNx0U1yPe0
7 changed files with 181 additions and 0 deletions

3
.gitignore vendored Normal file
View file

@ -0,0 +1,3 @@
__pycache__
/dist/
/.coverage*

162
pyproject.toml Normal file
View file

@ -0,0 +1,162 @@
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[project]
name = "infra-rebuild"
dynamic = ["version"]
description = "A simple NixOS deployment tool using nixos-rebuild internally, but trying to make infrastructure deployment more convenient."
readme = "README.md"
requires-python = ">=3.7"
keywords = ["nix", "NixOS"]
authors = [
{ name = "June", email = "june@jsts.xyz" },
]
classifiers = [
"License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
"Development Status :: 4 - Beta",
"Programming Language :: Python",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
]
dependencies = [
"click",
]
[project.urls]
Documentation = "https://git.hamburg.ccc.de/CCCHH/infra-rebuild#readme"
Issues = "https://git.hamburg.ccc.de/CCCHH/infra-rebuild/issues"
Source = "https://git.hamburg.ccc.de/CCCHH/infra-rebuild"
[project.scripts]
infra-rebuild = "infra_rebuild.cli:infra_rebuild"
[tool.hatch.version]
path = "src/infra_rebuild/__about__.py"
[tool.hatch.envs.default]
dependencies = [
"coverage[toml]>=6.5",
"pytest",
]
[tool.hatch.envs.default.scripts]
test = "pytest {args:tests}"
test-cov = "coverage run -m pytest {args:tests}"
cov-report = [
"- coverage combine",
"coverage report",
]
cov = [
"test-cov",
"cov-report",
]
[[tool.hatch.envs.all.matrix]]
python = ["3.7", "3.8", "3.9", "3.10", "3.11"]
[tool.hatch.envs.lint]
detached = true
dependencies = [
"black>=23.1.0",
"mypy>=1.0.0",
"ruff>=0.0.243",
]
[tool.hatch.envs.lint.scripts]
typing = "mypy --install-types --non-interactive {args:src/infra_rebuild tests}"
style = [
"ruff {args:.}",
"black --check --diff {args:.}",
]
fmt = [
"black {args:.}",
"ruff --fix {args:.}",
"style",
]
all = [
"style",
"typing",
]
[tool.black]
target-version = ["py37"]
line-length = 120
skip-string-normalization = true
[tool.ruff]
target-version = "py37"
line-length = 120
select = [
"A",
"ARG",
"B",
"C",
"DTZ",
"E",
"EM",
"F",
"FBT",
"I",
"ICN",
"ISC",
"N",
"PLC",
"PLE",
"PLR",
"PLW",
"Q",
"RUF",
"S",
"T",
"TID",
"UP",
"W",
"YTT",
]
ignore = [
# Allow non-abstract empty methods in abstract base classes
"B027",
# Allow boolean positional values in function calls, like `dict.get(... True)`
"FBT003",
# Ignore checks for possible passwords
"S105", "S106", "S107",
# Ignore complexity
"C901", "PLR0911", "PLR0912", "PLR0913", "PLR0915",
]
unfixable = [
# Don't touch unused imports
"F401",
]
[tool.ruff.isort]
known-first-party = ["infra_rebuild"]
[tool.ruff.flake8-tidy-imports]
ban-relative-imports = "all"
[tool.ruff.per-file-ignores]
# Tests can use magic values, assertions, and relative imports
"tests/**/*" = ["PLR2004", "S101", "TID252"]
[tool.coverage.run]
source_pkgs = ["infra_rebuild", "tests"]
branch = true
parallel = true
omit = [
"src/infra_rebuild/__about__.py",
]
[tool.coverage.paths]
infra_rebuild = ["src/infra_rebuild", "*/infra-rebuild/src/infra_rebuild"]
tests = ["tests", "*/infra-rebuild/tests"]
[tool.coverage.report]
exclude_lines = [
"no cov",
"if __name__ == .__main__.:",
"if TYPE_CHECKING:",
]

View file

@ -0,0 +1 @@
__version__ = "0.0.1"

View file

View file

@ -0,0 +1,6 @@
import sys
if __name__ == "__main__":
from infra_rebuild.cli import infra_rebuild
sys.exit(infra_rebuild())

View file

@ -0,0 +1,9 @@
import click
from infra_rebuild.__about__ import __version__
@click.group(context_settings={"help_option_names": ["-h", "--help"]}, invoke_without_command=True)
@click.version_option(version=__version__, prog_name="infra-rebuild")
def infra_rebuild():
click.echo("Hello world!")

0
tests/__init__.py Normal file
View file