python-checks 0.2.0__tar.gz → 0.3.1__tar.gz

python_checks-0.2.0/README.md → python_checks-0.3.1/PKG-INFO

@@ -1,3 +1,24 @@
+Metadata-Version: 2.4
+Name: python-checks
+Version: 0.3.1
+Summary: Проверки архитектурных соглашений проекта
+Author: Armontex
+Author-email: Armontex <windle1337@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Dist: libcst>=1.9,<2
+Requires-Dist: pydantic>=2.13.5,<3
+Requires-Dist: pydantic-settings>=2.15.0,<3
+Requires-Dist: rich>=14.0.0,<16.0.0
+Requires-Dist: typer>=0.27.2,<0.28
+Requires-Python: >=3.14
+Project-URL: Homepage, https://github.com/Armontex/py-checks
+Project-URL: Source, https://github.com/Armontex/py-checks
+Project-URL: Issues, https://github.com/Armontex/py-checks/issues
+Project-URL: Changelog, https://github.com/Armontex/py-checks/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/Armontex/py-checks/blob/main/docs/service.md
+Description-Content-Type: text/markdown
+
 <div align="center">
 
 <img src="docs/logo.svg" width="112" alt="py-checks">
@@ -8,11 +29,11 @@
 
 [![ci](https://github.com/Armontex/py-checks/actions/workflows/ci.yml/badge.svg)](https://github.com/Armontex/py-checks/actions/workflows/ci.yml)
 [![python](https://img.shields.io/badge/python-3.14%2B-3776AB)](https://www.python.org/)
-[![правил](https://img.shields.io/badge/checks-27-2ea043)](#что-проверяется)
+[![правил](https://img.shields.io/badge/checks-28-2ea043)](#что-проверяется)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-FAB040)](#pre-commit)
 [![ruff](https://img.shields.io/badge/linted%20with-ruff-261230)](https://docs.astral.sh/ruff/)
 [![pyright](https://img.shields.io/badge/types-pyright%20strict-1f6feb)](https://microsoft.github.io/pyright/)
-[![license](https://img.shields.io/badge/license-MIT-750014)](LICENSE)
+[![license](https://img.shields.io/badge/license-MIT-750014)](https://github.com/Armontex/py-checks/blob/main/LICENSE)
 
 </div>
 
@@ -44,7 +65,7 @@ src/app/presentation/api/v1/routers/bets.py:22:1: endpoint-declarations: POST /b
 - **Правило универсально, таблица — ваша.** Одно правило «этот вызов живёт только здесь» закрывает и границу транзакции, и запрет `float` в домене. Библиотека не содержит ни одного имени вашего проекта.
 - **Отказ объясняет себя.** Сообщение говорит, что не так и чем это заменить, а не «нарушение правила №14».
 - **Исключение стоит одной строки, но требует причины.** `# check-ok: raw-sql: проба живости, формы ORM нет` — пометка без причины сама становится нарушением.
-- **Чужую работу мы не делаем.** Что умеют ruff, pyright и import-linter — остаётся за ними; что и почему туда отдано, записано в [`docs/service.md`](docs/service.md).
+- **Чужую работу мы не делаем.** Что умеют ruff, pyright и import-linter — остаётся за ними; что и почему туда отдано, записано в [`docs/service.md`](https://github.com/Armontex/py-checks/blob/main/docs/service.md).
 
 ## Установка
 
@@ -91,7 +112,7 @@ py-checks explain determinism   # что правило требует и как
 
 ## Что проверяется
 
-Двадцать семь правил в девяти группах:
+Двадцать восемь правил в девяти группах:
 
 | Группа | О чём |
 |---|---|
@@ -106,7 +127,7 @@ py-checks explain determinism   # что правило требует и как
 | `hygiene` | потолок у зависимости |
 
 <details>
-<summary>Все двадцать семь</summary>
+<summary>Все двадцать восемь</summary>
 
 | Код | Что падает | Вид |
 |---|---|:-:|
@@ -143,7 +164,7 @@ py-checks explain determinism   # что правило требует и как
 
 Каждое правило объясняет себя целиком — `py-checks explain <код>` печатает
 докстринг с причиной и список настроек. Заготовка таблиц для типового сервиса
-лежит в [`docs/service.md`](docs/service.md).
+лежит в [`docs/service.md`](https://github.com/Armontex/py-checks/blob/main/docs/service.md).
 
 ### Три вида правил
 
@@ -163,7 +184,7 @@ text("SELECT 1")  # db-ok: raw-sql: проба живости, формы ORM н
 
 Каноническая форма — `# check-ok: <код>: <причина>`, она снимает ровно одно
 правило. У каждой группы есть своё короткое слово (`# db-ok`, `# type-ok`,
-`# signature-ok`, …): человек помнит группу, а не двадцать семь кодов.
+`# signature-ok`, …): человек помнит группу, а не двадцать восемь кодов.
 
 Пометок в строке может стоять несколько — подпись в столбик собирает их на
 последней строке:
@@ -217,6 +238,10 @@ py-checks sync --check   # упасть, если файл отстал
 которого нет, в контракт не попадает — иначе import-linter упал бы на первом же
 несуществующем модуле. Гоняет граф по собранному файлу хук самого import-linter.
 
+Шапку собранного файла можно написать свою — `header` в `[contracts]`, вместе
+с `#`; как и у `.env.example`, нужна она проекту с комментариями на другом
+языке.
+
 ## Пример окружения
 
 Имя переменной знает поле настроек — оно объявляет его `validation_alias`, и
@@ -315,8 +340,8 @@ uv run pytest -q
 `tests/projects/<код>__<вариант>/`. Библиотека проверяет сама себя: правило,
 которое не выдерживает свой же репозиторий, до чужого доезжать не должно.
 
-Соглашения репозитория — в [`AGENTS.md`](AGENTS.md).
+Соглашения репозитория — в [`AGENTS.md`](https://github.com/Armontex/py-checks/blob/main/AGENTS.md).
 
 ## Лицензия
 
-[MIT](LICENSE) — © 2026 Armontex.
+[MIT](https://github.com/Armontex/py-checks/blob/main/LICENSE) — © 2026 Armontex.

python_checks-0.2.0/PKG-INFO → python_checks-0.3.1/README.md

@@ -1,19 +1,3 @@
-Metadata-Version: 2.4
-Name: python-checks
-Version: 0.2.0
-Summary: Проверки архитектурных соглашений проекта
-Author: Armontex
-Author-email: Armontex <windle1337@gmail.com>
-License-Expression: MIT
-License-File: LICENSE
-Requires-Dist: libcst>=1.9,<2
-Requires-Dist: pydantic>=2.13.5,<3
-Requires-Dist: pydantic-settings>=2.15.0,<3
-Requires-Dist: rich>=14.0.0,<16.0.0
-Requires-Dist: typer>=0.27.2,<0.28
-Requires-Python: >=3.14
-Description-Content-Type: text/markdown
-
 <div align="center">
 
 <img src="docs/logo.svg" width="112" alt="py-checks">
@@ -24,11 +8,11 @@ Description-Content-Type: text/markdown
 
 [![ci](https://github.com/Armontex/py-checks/actions/workflows/ci.yml/badge.svg)](https://github.com/Armontex/py-checks/actions/workflows/ci.yml)
 [![python](https://img.shields.io/badge/python-3.14%2B-3776AB)](https://www.python.org/)
-[![правил](https://img.shields.io/badge/checks-27-2ea043)](#что-проверяется)
+[![правил](https://img.shields.io/badge/checks-28-2ea043)](#что-проверяется)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-FAB040)](#pre-commit)
 [![ruff](https://img.shields.io/badge/linted%20with-ruff-261230)](https://docs.astral.sh/ruff/)
 [![pyright](https://img.shields.io/badge/types-pyright%20strict-1f6feb)](https://microsoft.github.io/pyright/)
-[![license](https://img.shields.io/badge/license-MIT-750014)](LICENSE)
+[![license](https://img.shields.io/badge/license-MIT-750014)](https://github.com/Armontex/py-checks/blob/main/LICENSE)
 
 </div>
 
@@ -60,7 +44,7 @@ src/app/presentation/api/v1/routers/bets.py:22:1: endpoint-declarations: POST /b
 - **Правило универсально, таблица — ваша.** Одно правило «этот вызов живёт только здесь» закрывает и границу транзакции, и запрет `float` в домене. Библиотека не содержит ни одного имени вашего проекта.
 - **Отказ объясняет себя.** Сообщение говорит, что не так и чем это заменить, а не «нарушение правила №14».
 - **Исключение стоит одной строки, но требует причины.** `# check-ok: raw-sql: проба живости, формы ORM нет` — пометка без причины сама становится нарушением.
-- **Чужую работу мы не делаем.** Что умеют ruff, pyright и import-linter — остаётся за ними; что и почему туда отдано, записано в [`docs/service.md`](docs/service.md).
+- **Чужую работу мы не делаем.** Что умеют ruff, pyright и import-linter — остаётся за ними; что и почему туда отдано, записано в [`docs/service.md`](https://github.com/Armontex/py-checks/blob/main/docs/service.md).
 
 ## Установка
 
@@ -107,7 +91,7 @@ py-checks explain determinism   # что правило требует и как
 
 ## Что проверяется
 
-Двадцать семь правил в девяти группах:
+Двадцать восемь правил в девяти группах:
 
 | Группа | О чём |
 |---|---|
@@ -122,7 +106,7 @@ py-checks explain determinism   # что правило требует и как
 | `hygiene` | потолок у зависимости |
 
 <details>
-<summary>Все двадцать семь</summary>
+<summary>Все двадцать восемь</summary>
 
 | Код | Что падает | Вид |
 |---|---|:-:|
@@ -159,7 +143,7 @@ py-checks explain determinism   # что правило требует и как
 
 Каждое правило объясняет себя целиком — `py-checks explain <код>` печатает
 докстринг с причиной и список настроек. Заготовка таблиц для типового сервиса
-лежит в [`docs/service.md`](docs/service.md).
+лежит в [`docs/service.md`](https://github.com/Armontex/py-checks/blob/main/docs/service.md).
 
 ### Три вида правил
 
@@ -179,7 +163,7 @@ text("SELECT 1")  # db-ok: raw-sql: проба живости, формы ORM н
 
 Каноническая форма — `# check-ok: <код>: <причина>`, она снимает ровно одно
 правило. У каждой группы есть своё короткое слово (`# db-ok`, `# type-ok`,
-`# signature-ok`, …): человек помнит группу, а не двадцать семь кодов.
+`# signature-ok`, …): человек помнит группу, а не двадцать восемь кодов.
 
 Пометок в строке может стоять несколько — подпись в столбик собирает их на
 последней строке:
@@ -233,6 +217,10 @@ py-checks sync --check   # упасть, если файл отстал
 которого нет, в контракт не попадает — иначе import-linter упал бы на первом же
 несуществующем модуле. Гоняет граф по собранному файлу хук самого import-linter.
 
+Шапку собранного файла можно написать свою — `header` в `[contracts]`, вместе
+с `#`; как и у `.env.example`, нужна она проекту с комментариями на другом
+языке.
+
 ## Пример окружения
 
 Имя переменной знает поле настроек — оно объявляет его `validation_alias`, и
@@ -331,8 +319,8 @@ uv run pytest -q
 `tests/projects/<код>__<вариант>/`. Библиотека проверяет сама себя: правило,
 которое не выдерживает свой же репозиторий, до чужого доезжать не должно.
 
-Соглашения репозитория — в [`AGENTS.md`](AGENTS.md).
+Соглашения репозитория — в [`AGENTS.md`](https://github.com/Armontex/py-checks/blob/main/AGENTS.md).
 
 ## Лицензия
 
-[MIT](LICENSE) — © 2026 Armontex.
+[MIT](https://github.com/Armontex/py-checks/blob/main/LICENSE) — © 2026 Armontex.

{python_checks-0.2.0 → python_checks-0.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-checks"
-version = "0.2.0"
+version = "0.3.1"
 description = "Проверки архитектурных соглашений проекта"
 readme = "README.md"
 license = "MIT"
@@ -18,6 +18,13 @@ dependencies = [
 name = "Armontex"
 email = "windle1337@gmail.com"
 
+[project.urls]
+Homepage = "https://github.com/Armontex/py-checks"
+Source = "https://github.com/Armontex/py-checks"
+Issues = "https://github.com/Armontex/py-checks/issues"
+Changelog = "https://github.com/Armontex/py-checks/blob/main/CHANGELOG.md"
+Documentation = "https://github.com/Armontex/py-checks/blob/main/docs/service.md"
+
 [project.scripts]
 py-checks = "py_checks.cli:main"
 

{python_checks-0.2.0 → python_checks-0.3.1}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "python-checks"
-version = "0.2.0"
+version = "0.3.1"
 description = "Проверки архитектурных соглашений проекта"
 readme = "README.md"
 license = "MIT"
@@ -18,6 +18,16 @@ dependencies = [
     "typer>=0.27.2,<0.28",
 ]
 
+# Страница на PyPI — это README и эта таблица, больше там ничего нет:
+# ссылки из README ведут в репозиторий по полному адресу, потому что
+# относительный путь PyPI разрешает у себя и упирается в 404.
+[project.urls]
+Homepage = "https://github.com/Armontex/py-checks"
+Source = "https://github.com/Armontex/py-checks"
+Issues = "https://github.com/Armontex/py-checks/issues"
+Changelog = "https://github.com/Armontex/py-checks/blob/main/CHANGELOG.md"
+Documentation = "https://github.com/Armontex/py-checks/blob/main/docs/service.md"
+
 [project.scripts]
 py-checks = "py_checks.cli:main"
 

{python_checks-0.2.0 → python_checks-0.3.1}/src/py_checks/contracts/_render.py

@@ -45,12 +45,15 @@ def render(
     )
     if not blocks:
         return None
+    head = contracts(config=config).header.strip() or HEADER.format(
+        # Секция зовётся по-разному в манифесте и в своём файле настроек:
+        # написать одно имя значит послать читателя не туда в половине
+        # проектов.
+        section=f"{prefix(source=config.origin)}{SECTION}"
+    )
     return "\n".join(
         [
-            # Секция зовётся по-разному в манифесте и в своём файле настроек:
-            # написать одно имя значит послать читателя не туда в половине
-            # проектов.
-            HEADER.format(section=f"{prefix(source=config.origin)}{SECTION}"),
+            f"{head.rstrip()}\n",
             _roots(
                 root=root,
                 package=name,

{python_checks-0.2.0 → python_checks-0.3.1}/src/py_checks/contracts/_settings.py

@@ -24,10 +24,14 @@ class Contracts(CheckSettings):
     собой, и это вся их работа. Перечислять их отдельно нужно затем, чтобы они
     попали в запреты остальных: слой, о котором таблица не знает, ничьим
     запретом не становится.
+
+    `header` — шапка собранного файла со своим текстом, вместе с `#`. Пустая
+    строка оставляет шапку библиотеки.
     """
 
     composition_root: tuple[str, ...] = ()
     layers: dict[str, tuple[str, ...]] = {}
+    header: str = ""
 
 
 def contracts(*, config: Config) -> Contracts: