feat: add the template

emptybutton · emptybutton · commit 0933ea043cbb · 2025-05-03T14:45:02.000+07:00
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,5 @@
+.git
+.venv
+.mypy_cache
+.pytest_cache
+.ruff_cache
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -0,0 +1,49 @@
+name: CD
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.13"
+      - uses: yezz123/setup-uv@v4
+
+      - name: build
+        run: uv build
+
+      - name: upload build
+        uses: actions/upload-artifact@v4
+        with:
+          name: build
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/lib_dist_name
+    needs:
+      - build
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.13"
+      - uses: yezz123/setup-uv@v4
+
+      - name: retrieve build
+        uses: actions/download-artifact@v4
+        with:
+          name: build
+          path: dist/
+
+      - name: publish
+        run: uv publish
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,25 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: ruff
+        run: docker compose -f deployments/dev/docker-compose.yaml run lib-kebab-case ruff check src tests
+
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: mypy
+        run: docker compose -f deployments/dev/docker-compose.yaml run lib-kebab-case mypy src tests
+
+  pytest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: pytest
+        run: docker compose -f deployments/dev/docker-compose.yaml run lib-kebab-case pytest tests
diff --git a/.gitignore b/.gitignore
@@ -167,8 +167,10 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
-# Ruff stuff:
-.ruff_cache/
-
 # PyPI configuration file
 .pypirc
+
+# Custom
+.python-version
+.ruff_cache
+.uv_cache
diff --git a/README.md b/README.md
@@ -1,2 +1,21 @@
-# library
-Template for libs with CI/CD using ruff, mypy, pytest, uv, pypi
+# lib-kebab-case
+[![CI](https://github.com/emptybutton/lib-kebab-case/actions/workflows/ci.yml/badge.svg)](https://github.com/emptybutton/lib-kebab-case/actions?query=workflow%3ACI)
+[![CD](https://github.com/emptybutton/lib-kebab-case/actions/workflows/cd.yml/badge.svg)](https://github.com/emptybutton/lib-kebab-case/actions/workflows/cd.yaml)
+[![GitHub Release](https://img.shields.io/github/v/release/emptybutton/lib-kebab-case?style=flat&logo=github&labelColor=%23282e33&color=%237c73ff)](https://github.com/emptybutton/lib-kebab-case/releases)
+[![Lines](https://img.shields.io/endpoint?url=https%3A%2F%2Fghloc.vercel.app%2Fapi%2Femptybutton%2Flib-kebab-case%2Fbadge%3Ffilter%3D.py&logo=python&label=lines&color=blue)](https://github.com/search?q=repo%3Aemptybutton%2lib-kebab-case+language%3APython+&type=code)
+
+lib_description.
+
+```bash
+pip install lib_dist_name
+```
+
+## Шаги индивидуализации
+Заменить:
+1. `lib-kebab-case` - на название либы в kebab-case
+2. `lib_snake_case` - на название либы в snake_case
+3. `lib_description` - на описание
+4. `lib_dist_name` - на название либы для распространения
+
+Добавить `secrets.PYPI_TOKEN` в окружение `pypi` для доставки.
+Удалить эту информацию.
diff --git a/deployments/dev/docker-compose.yaml b/deployments/dev/docker-compose.yaml
@@ -0,0 +1,18 @@
+name: lib-kebab-case
+
+services:
+  lib-kebab-case:
+    image: lib-kebab-case:dev
+    container_name: lib-kebab-case
+    build:
+      context: ../../
+      dockerfile: deployments/dev/lib_snake_case/Dockerfile
+      tags:
+        - "lib-kebab-case:dev"
+    volumes:
+      - ../..:/app
+      - lib-kebab-case-data:/run/app
+    command: bash
+
+volumes:
+  lib-kebab-case-data: null
diff --git a/deployments/dev/lib_snake_case/Dockerfile b/deployments/dev/lib_snake_case/Dockerfile
@@ -0,0 +1,12 @@
+FROM ghcr.io/astral-sh/uv:python3.13-bookworm-slim AS app
+
+WORKDIR /app
+
+ENV UV_LINK_MODE copy
+ENV UV_PROJECT_ENVIRONMENT /run/app/.venv
+ENV UV_CACHE_DIR /run/app/uv
+
+ENV PYTHONPATH /app/src:/app/tests
+ENV WATCHFILES_FORCE_POLLING true
+
+ENTRYPOINT ["bash", "deployments/dev/lib_snake_case/entrypoint.sh"]
diff --git a/deployments/dev/lib_snake_case/entrypoint.sh b/deployments/dev/lib_snake_case/entrypoint.sh
@@ -0,0 +1,4 @@
+#!/bin/bash
+
+source ${UV_PROJECT_ENVIRONMENT}/bin/activate
+$@
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,68 @@
+[project]
+name = "lib_dist_name"
+version = "0.2.0"
+description = "lib_description"
+authors = [
+    {name = "Alexander Smolin", email = "88573504+emptybutton@users.noreply.github.com"}
+]
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.13"
+dependencies = []
+
+[project.urls]
+Repository = "https://github.com/emptybutton/lib-kebab-case"
+
+[project.optional-dependencies]
+dev = [
+    "mypy[faster-cache]==1.15.0",
+    "ruff==0.9.7",
+    "pytest==8.3.4",
+    "pytest-asyncio==0.25.3",
+    "pytest-cov==6.0.0",
+    "dirty-equals==0.8.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/lib_snake_case"]
+
+[tool.mypy]
+mypy_path = "$MYPY_CONFIG_FILE_DIR/src:$MYPY_CONFIG_FILE_DIR/tests"
+strict = true
+no_namespace_packages = true
+allow_redefinition = true
+
+[tool.ruff]
+src = ["src"]
+preview = true
+line-length = 90
+indent-width = 4
+
+[tool.ruff.lint]
+select = [
+    "ANN", "F", "W", "E", "B", "C90", "N", "UP", "YTT", "ASYNC", "PL", "RUF",
+    "Q", "RET", "SLF", "SLOT", "SIM", "TID252", "TCH", "ARG", "PTH", "ERA", "TRY",
+    "PERF", "INP", "I", "S", "FAST", "TID", "TCH", "INT"
+]
+ignore = ["N818", "RUF009", "UP018", "PLR6301", "PLR0913", "PLW0108", "TC006", "UP049", "UP046"]
+
+[tool.ruff.lint.isort]
+lines-after-imports = 2
+
+[tool.ruff.lint.per-file-ignores]
+"src/*" = ["PLR2004"]
+"tests/*" = ["S101", "PLR0124", "PLR0917", "S106", "C901"]
+"__init__.py" = ["PLC0414"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "session"
+
+[tool.coverage.run]
+branch = true
+source = ["src/"]
diff --git a/src/lib_snake_case/__init__.py b/src/lib_snake_case/__init__.py
@@ -0,0 +1 @@
+from lib_snake_case.x import X as X
diff --git a/src/lib_snake_case/py.typed b/src/lib_snake_case/py.typed
diff --git a/src/lib_snake_case/x.py b/src/lib_snake_case/x.py
@@ -0,0 +1,4 @@
+from typing import Literal
+
+
+type X = Literal["x"]
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/test_lib_snake_case/__init__.py b/tests/test_lib_snake_case/__init__.py
diff --git a/tests/test_lib_snake_case/test_x.py b/tests/test_lib_snake_case/test_x.py
@@ -0,0 +1,7 @@
+from lib_snake_case.x import X
+
+
+def test_x() -> None:
+    x: X = "x"
+
+    assert x == "x"
diff --git a/uv.lock b/uv.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +#!/bin/bash
++
 +source ${UV_PROJECT_ENVIRONMENT}/bin/activate
 +$@