python-checks 0.2.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

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,

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:

{python_checks-0.2.0.dist-info → python_checks-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-checks
-Version: 0.2.0
+Version: 0.3.1
 Summary: Проверки архитектурных соглашений проекта
 Author: Armontex
 Author-email: Armontex <windle1337@gmail.com>
@@ -12,6 +12,11 @@ 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">
@@ -24,11 +29,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 +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).
 
 ## Установка
 
@@ -107,7 +112,7 @@ py-checks explain determinism   # что правило требует и как
 
 ## Что проверяется
 
-Двадцать семь правил в девяти группах:
+Двадцать восемь правил в девяти группах:
 
 | Группа | О чём |
 |---|---|
@@ -122,7 +127,7 @@ py-checks explain determinism   # что правило требует и как
 | `hygiene` | потолок у зависимости |
 
 <details>
-<summary>Все двадцать семь</summary>
+<summary>Все двадцать восемь</summary>
 
 | Код | Что падает | Вид |
 |---|---|:-:|
@@ -159,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).
 
 ### Три вида правил
 
@@ -179,7 +184,7 @@ text("SELECT 1")  # db-ok: raw-sql: проба живости, формы ORM н
 
 Каноническая форма — `# check-ok: <код>: <причина>`, она снимает ровно одно
 правило. У каждой группы есть своё короткое слово (`# db-ok`, `# type-ok`,
-`# signature-ok`, …): человек помнит группу, а не двадцать семь кодов.
+`# signature-ok`, …): человек помнит группу, а не двадцать восемь кодов.
 
 Пометок в строке может стоять несколько — подпись в столбик собирает их на
 последней строке:
@@ -233,6 +238,10 @@ py-checks sync --check   # упасть, если файл отстал
 которого нет, в контракт не попадает — иначе import-linter упал бы на первом же
 несуществующем модуле. Гоняет граф по собранному файлу хук самого import-linter.
 
+Шапку собранного файла можно написать свою — `header` в `[contracts]`, вместе
+с `#`; как и у `.env.example`, нужна она проекту с комментариями на другом
+языке.
+
 ## Пример окружения
 
 Имя переменной знает поле настроек — оно объявляет его `validation_alias`, и
@@ -331,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.dist-info → python_checks-0.3.1.dist-info}/RECORD

@@ -70,8 +70,8 @@ py_checks/config/_toml.py,sha256=NZaLKJhnBjo-ZImeLCNcJJBxuRE0LYlltgf0dAVYVaE,703
 py_checks/contracts/__init__.py,sha256=oPoF3D9kN9n-oLdh5Ug40Omp1_eJpocNlGMomUTP4xs,1142
 py_checks/contracts/_constants.py,sha256=nKfAs2IJdFdxCxazEG0t_AIeBt6QdAkhhNHNE9dK7lU,664
 py_checks/contracts/_layout.py,sha256=wlZSk0ioVGHtWcnHTwwSGOV35XDi6to0XuOhqqp6Mx0,1829
-py_checks/contracts/_render.py,sha256=vMrQuzheihJS-D367tW3KNQvf8jhOZWWptLFLGvO4hE,6598
-py_checks/contracts/_settings.py,sha256=ItaYTDCZGHEnTaCgPkNwuE0FFlvzM4JABfBpE61dzVI,1556
+py_checks/contracts/_render.py,sha256=6aYauVYwp5O3bS1yVu075WHTS9mII_ZhiuS4m51CrMU,6675
+py_checks/contracts/_settings.py,sha256=CA-6fW_FfCmVn4gtJbpgoDi6F2DGCN9mETPE5V7SSew,1773
 py_checks/core/__init__.py,sha256=9XspaoOu-6X7hBLVjyXuXNTyghji_ttC_tQqc82JgsA,1690
 py_checks/core/_constants.py,sha256=G0h499Qoyuqg_PSgfl9El3ObESdoyFbX8BkAt2jvkpE,820
 py_checks/core/_discovery.py,sha256=e2JEGepp3TZpn-v_U7U28wGCvbcyO2jQJ3VawnYMlcQ,1673
@@ -94,8 +94,8 @@ py_checks/environment/_settings.py,sha256=Pr0xE05tt7iagffzK11NncTN22QeoZKtxA2zuC
 py_checks/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 py_checks/sync/__init__.py,sha256=Kg08BC7arCTqdFk2tO3qm95_jG-X0vxK-GMvVYJEkXc,1041
 py_checks/sync/_sync.py,sha256=KqA65H4zeP6y17LwlRR8svpCuhUdFCY3KIwG3YtuvAk,2254
-python_checks-0.2.0.dist-info/licenses/LICENSE,sha256=omcAXq_cAQNMI5X3fRdH7UC6W2Zc8AC-G9xIZ2U1xF0,1065
-python_checks-0.2.0.dist-info/WHEEL,sha256=R1d3uUTbmXM1FHXH_itQashbrqrOSVj-hvBCpmkIIGE,81
-python_checks-0.2.0.dist-info/entry_points.txt,sha256=59rS_KMwYdFnQ9HuhkBpKQNKySNAALyneIFO_-cVQvw,1679
-python_checks-0.2.0.dist-info/METADATA,sha256=BkUvC0fGjPHRTS1wn_38b4Zi4xn3ma0LDfDu-8F5i7c,19452
-python_checks-0.2.0.dist-info/RECORD,,
+python_checks-0.3.1.dist-info/licenses/LICENSE,sha256=omcAXq_cAQNMI5X3fRdH7UC6W2Zc8AC-G9xIZ2U1xF0,1065
+python_checks-0.3.1.dist-info/WHEEL,sha256=R1d3uUTbmXM1FHXH_itQashbrqrOSVj-hvBCpmkIIGE,81
+python_checks-0.3.1.dist-info/entry_points.txt,sha256=59rS_KMwYdFnQ9HuhkBpKQNKySNAALyneIFO_-cVQvw,1679
+python_checks-0.3.1.dist-info/METADATA,sha256=4L29ylf6LRb_U_YQ9DBVDzGMBb0htYdIEAeusbx6T0A,20322
+python_checks-0.3.1.dist-info/RECORD,,