{"id":27042498,"url":"https://github.com/dimflix/pytemplate","last_synced_at":"2025-04-05T04:28:44.846Z","repository":{"id":278232978,"uuid":"934954951","full_name":"DIMFLIX/PyTemplate","owner":"DIMFLIX","description":"My template for a python projects","archived":false,"fork":false,"pushed_at":"2025-03-31T16:05:38.000Z","size":35,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-31T17:03:01.938Z","etag":null,"topics":["gitignore","makefile","pre-commit","project-template","python","ruff","template","uv"],"latest_commit_sha":null,"homepage":"","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DIMFLIX.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-18T17:07:50.000Z","updated_at":"2025-03-31T16:05:42.000Z","dependencies_parsed_at":"2025-03-21T09:36:03.036Z","dependency_job_id":"fa1afd55-d52b-43b4-812e-6d06562d2e1f","html_url":"https://github.com/DIMFLIX/PyTemplate","commit_stats":null,"previous_names":["dimflix-official/pytemplate","dimflix/pytemplate"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DIMFLIX%2FPyTemplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DIMFLIX%2FPyTemplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DIMFLIX%2FPyTemplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DIMFLIX%2FPyTemplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DIMFLIX","download_url":"https://codeload.github.com/DIMFLIX/PyTemplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247289401,"owners_count":20914463,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gitignore","makefile","pre-commit","project-template","python","ruff","template","uv"],"created_at":"2025-04-05T04:28:44.265Z","updated_at":"2025-04-05T04:28:44.823Z","avatar_url":"https://github.com/DIMFLIX.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PyTemplate\nЭтот шаблон предоставляет готовую структуру для Python-проектов с предварительно настроенными инструментами разработки, CI и линтингом.\n\n## 📦 Основные возможности\n- Стандартизированная структура проекта\n- Интеграция инструментов линтинга и форматирования\n- Интеграция инструмента `pre-commit`\n- Интеграция инструмента `make`\n- Использование `uv` в качестве пакетного менеджера\n- Настройки тестирования с pytest\n\n## 🚀 Быстрый старт\n\n### 1. Клонирование шаблона\n```bash\ngit clone https://github.com/DIMFLIX-OFFICIAL/PyTemplate.git\ncd PyTemplate\n```\n\n### 2. Инициализация проекта\nЗамените значения в файлах:\n- `pyproject.toml` - имя проекта, версия, описание\n- Обновите `LICENSE` при необходимости\n\n### 3. Инициализация pre-commit\n```bash\nuvx pre-commit install\n```\n\n### 4. Инициализация крючка detect-secrets\n```bash\nuvx detect-secrets scan \u003e .secrets.baseline\n```\n\n## 🛠 Инструменты разработки\n\n### Линтинг и форматирование\n- **ruff** - автоматическое форматирование\n- **Flake8** - проверка стиля кода\n- **isort** - сортировка импортов\n- **pre-commit** - набор утилит для исправления проекта\n\n\n## Немного о pre-commit\n| Репозиторий/Хук               | Назначение                                              | Конфигурация/Особенности                                         |\n| ----------------------------- | ------------------------------------------------------- | ---------------------------------------------------------------- |\n| **Bandit**                    |                                                         |                                                                  |\n| `bandit`                      | Поиск уязвимостей в Python-коде                         | Конфигурация из `pyproject.toml`                                 |\n| **pre-commit-hooks**          |                                                         |                                                                  |\n| `trailing-whitespace`         | Удаление пробелов в конце строк                         | Автоматическое исправление                                       |\n| `check-yaml`                  | Проверка синтаксиса YAML-файлов                         |                                                                  |\n| `check-merge-conflict`        | Поиск конфликтов слияния (`\u003c\u003c\u003c\u003c\u003c\u003c\u003c`)                    |                                                                  |\n| `detect-private-key`          | Обнаружение приватных ключей в коде                     |                                                                  |\n| `debug-statements`            | Проверка на отладочные вызовы (e.g., `pdb.set_trace()`) |                                                                  |\n| **pyupgrade**                 |                                                         |                                                                  |\n| `pyupgrade`                   | Автоматическое обновление синтаксиса Python             | Целевая версия: 3.11+                                            |\n| **ruff-pre-commit**           |                                                         |                                                                  |\n| `ruff`                        | Линтинг + форматирование кода                           | Автофикс, исключение `migrations`                                |\n| **autoflake**                 |                                                         |                                                                  |\n| `autoflake`                   | Удаление неиспользуемых импортов и переменных           | Автоматическое исправление                                       |\n| **check-jsonschema**          |                                                         |                                                                  |\n| `check-github-workflows`      | Валидация GitHub Actions workflow-файлов                |                                                                  |\n| `check-dependabot`            | Проверка конфигурации Dependabot                        |                                                                  |\n| **pygrep-hooks**              |                                                         |                                                                  |\n| `python-use-type-annotations` | Проверка обязательных аннотаций типов                   |                                                                  |\n| `python-check-blanket-noqa`   | Проверка неконкретных `# noqa` комментариев             |                                                                  |\n| **detect-secrets**            |                                                         |                                                                  |\n| `detect-secrets`              | Поиск секретов (API-ключи, пароли)                      | Базовый файл `.secrets.baseline`, исключение `package.lock.json` |\n| **pre-commit-images**         |                                                         |                                                                  |\n| `optimize-png`                | Оптимизация PNG-изображений                             | Автоматическое сжатие                                            |\n| `optimize-svg`                | Оптимизация SVG-файлов                                  | Удаление метаданных, минификация                                 |\n\n## 🔄 Работа с Makefile\nОсновные команды:\n```bash\nmake help          # Показать все команды\nmake fmt           # Запуск pre-commit для всех файлов\nmake clean         # Очистить временные файлы\n```\n\n## 📂 Структура проекта\n```\n.\n├── .vscode/            # Настройки для vscode\n│   ├── extensions.json # Рекомендуемые расширения в vscode для проекта\n│   └── settings.json   # Базовые настройки vscode\n├── src/                # Исходный код проекта\n│   ├── __init__.py\n│   └── app.py\n├── tests/              # Тесты\n├── ruff.toml           # Конфиг ruff\n├── .pre-commit-config.yaml # Настройки pre-commit\n├── pyproject.toml      # Конфигурация проекта\n├── Makefile            # Утилиты для разработки\n├── .gitignore          # Игнорирование файлов/папок в системе git\n├── README.md           # Документация проекта\n└── LICENSE             # Лицензия проекта\n```\n\n## 🤝 Вклад в проект\n1. Создайте feature branch\n2. Добавьте тесты для новых функций (если есть)\n3. Запустите `make fmt` перед коммитом\n4. Откройте Pull Request с описанием изменений\n\n## 📄 Лицензия\nПроект распространяется под лицензией GNU GPL v3. \nПодробности см. в файле [LICENSE](LICENSE).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdimflix%2Fpytemplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdimflix%2Fpytemplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdimflix%2Fpytemplate/lists"}