pdoc3 / pdoc
🐍 ➡️ 📜 Auto-generate API documentation for Python projects
pdoc3/pdoc має індекс здоров’я 62 зі 100, що відповідає смузі «Помірний». Найвищий показник — Community & Adoption (79/100), найнижчий — AI Readiness (22/100). Останнє оновлення — сьогодні. Більшість нещодавньої роботи виконує один учасник.
Індекс здоров'я програмного забезпечення
Метрики згруповано у зважені категорії на шкалі 1–100. Загальна оцінка починається як їхнє зважене середнє, відкаліброване за розподілом публічного реєстру, тож діапазони мають перцентильний зміст; коли публічні дані активують Політику юрисдикцій високого ризику, рейтинг коригується й отримує верхню межу 34 («У зоні ризику»).
Профіль оцінок
Кожна вісь — окрема категорія. Форма важить більше, ніж середнє: здоровий об'єкт заповнює всю фігуру, тоді як профіль із піками та провалами означає, що сила в одному вимірі маскує ризик в іншому.
Зважений загальний бал 58 калібровано до 62 за шкалою опублікованого індексу (калібрування реєстру 2026-08-02).
Власність
За цим репозиторієм стоїть організація — спільна, підзвітна опіка, здатна пережити будь-якого окремого мейнтейнера.
Пакетні екосистеми
| Реєстр | Пакет | Версія | Завантажень / міс | Версії | Остання публікація |
|---|---|---|---|---|---|
| PyPI | pdoc3 | 0.11.6 | 276 078 | 36 | 487 днів тому |
Метрики за категоріями
Життєздатність
Чи живий проєкт — чи пишеться код і чи виходять релізи?
Активність розробки
Як обчислюється оцінка
| 36/36 | Свіжість push — останній push 0 дн. тому |
| 1.4/36 | Ритм комітів — 2/52 тижнів із комітами |
| 5.4/18 | Обсяг комітів — 3 комітів за останній рік |
| 0/10 | OpenSSF Scorecard: Maintained — 0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0 |
Використані вхідні дані
| commits_last_year | 3 |
| human_commit_share | — |
| days_since_last_push | 0 |
| active_weeks_last_year | 2 |
Дисципліна релізів
Як обчислюється оцінка
| 27/27 | Випускає релізи — опубліковано 1 релізів |
| 0/36 | Свіжість релізів — останній реліз 2 734 дн. тому |
| 12.6/27 | Ритм релізів — ритм невідомий (єдиний реліз) |
| 0/10 | OpenSSF Scorecard: Signed-Releases — немає даних |
Використані вхідні дані
| releases_count | 1 |
| latest_release_tag | 0.3.11 |
| releases_from_tags | ні |
| days_since_latest_release | 2 734 |
| mean_days_between_releases | — |
Спільнота та впровадження
Чи має проєкт користувачів, завантаження, увагу та влаштовані умови для контриб’юторів?
Популярність і впровадження
Як обчислюється оцінка
| 49.9/60 | Зірки — 1 191 зірок |
| 18/25 | Форки — 144 форків |
| 4.7/15 | Спостерігачі — 8 спостерігачів |
Використані вхідні дані
| forks | 144 |
| stars | 1 191 |
| watchers | 8 |
| growth_state | unverified |
| growth_factor_pct | 100 |
| growth_unverified_reason | no_history |
Здоров'я спільноти
Як обчислюється оцінка
| 22.5/22.5 | README |
| 22.5/22.5 | Ліцензія — визнана ліцензія (AGPL-3.0) |
| 18/18 | Настанови CONTRIBUTING |
| 0/13.5 | Кодекс поведінки |
| 7.2/7.2 | Шаблон issue |
| 0/6.3 | Шаблон PR |
Використані вхідні дані
| has_readme | так |
| has_license | так |
| readme_badges | — |
| has_contributing | так |
| has_issue_template | так |
| has_code_of_conduct | ні |
| readme_badge_services | — |
| has_pull_request_template | ні |
Впровадження в екосистемі (завантаження)
Як обчислюється оцінка
| 72.5/80 | Щомісячні завантаження — 276 078 завантажень/місяць у pypi |
| 0/20 | Залежні пакети в реєстрі — ця екосистема цього не повідомляє |
Використані вхідні дані
| packages | pdoc3 |
| dependents | — |
| ecosystems | pypi |
| total_downloads | — |
| monthly_downloads | 276 078 |
| unverified_packages_excluded | — |
Сталість та врядування
Чи переживе проєкт своїх людей — бас-фактор, реактивність, хто за ним стоїть і як супроводжуються пакети?
Стійкість мейнтейнерів (бас-фактор)
Як обчислюється оцінка
| 9/54 | Бас-фактор — на 1 контриб’ютор(ів) припадає половина всіх комітів |
| 9.5/22.5 | Розподіл комітів — головний контриб’ютор — автор 58% комітів |
| 13.5/13.5 | Широта контриб’юторів — 63 контриб’юторів |
| 10/10 | OpenSSF Scorecard: Contributors — project has 24 contributing companies or organizations |
Використані вхідні дані
| bus_factor | 1 |
| contributors_sampled | 63 |
| top_contributor_share | 0,577 |
Реактивність на issue та PR
Як обчислюється оцінка
| 29.9/42 | Вирішення issue — закрито 71% issue |
| 21.1/30 | Прийняття PR — злито 86/122 вирішених PR |
| 0/13 | Newcomer PR acceptance — за 30 дн. не вирішено жодного PR від новачка |
| 1.5/15 | OpenSSF Scorecard: Code-Review — Found 4/30 approved changesets -- score normalized to 1 |
Використані вхідні дані
| merged_prs | 86 |
| open_issues | 96 |
| closed_issues | 237 |
| prs_merged_7d | — |
| prs_decided_7d | — |
| prs_merged_30d | — |
| prs_decided_30d | — |
| issue_closed_ratio | 0,712 |
| closed_unmerged_prs | 36 |
| first_time_authors_30d | — |
| first_time_prs_merged_30d | — |
| first_time_prs_decided_30d | — |
Власність та опіка
Як обчислюється оцінка
| 30/30 | Підтримка власника — у власності організації |
| 0/20 | Верифікований домен — статус підтвердженого домену для цієї організації не зчитано |
| 7.5/25 | Охоплення власника — 10 підписників у pdoc3 |
| 15.5/25 | Послужний список — 2 публічних репозиторіїв, вік облікового запису ~7 р. |
Використані вхідні дані
| followers | 10 |
| owner_type | Organization |
| is_verified | — |
| owner_login | pdoc3 |
| public_repos | 2 |
| account_age_days | 2 757 |
Супровід пакетів
Як обчислюється оцінка
| 25/25 | Опубліковано й доступно — 1 пакет(ів) у pypi |
| 14/35 | Свіжість публікацій — остання публікація 487 дн. тому |
| 20/20 | Історія версій — 36 опублікованих версій |
| 20/20 | Не застарілий — активний, не deprecated і не yanked |
Використані вхідні дані
| packages | pdoc3 |
| ecosystems | pypi |
| any_deprecated | ні |
| min_days_since_publish | 487 |
Інженерна якість
Чи наявні базові інженерні практики та документація?
Інженерні практики
Як обчислюється оцінка
| 24/24 | Процеси CI — 2 процес(ів) CI |
| 24/24 | Наявні тести |
| 0/16 | Конфігурація лінтера |
| 0/9.6 | Pre-commit-хуки |
| 0/6.4 | .editorconfig |
| 4/20 | OpenSSF Scorecard: CI-Tests — 1 out of 4 merged PRs checked by a CI test -- score normalized to 2 |
Використані вхідні дані
| has_ci | так |
| has_tests | так |
| has_editorconfig | ні |
| has_linter_config | ні |
| has_precommit_config | ні |
Документація
Як обчислюється оцінка
| 30/30 | README |
| 25/25 | Каталог документації |
| 15/15 | Сайт документації / домашня сторінка — https://pdoc3.github.io/pdoc/ |
| 10/10 | Опис репозиторію |
| 10/10 | Теми — 15 тем |
| 0/10 | Wiki |
Використані вхідні дані
| topics | documentation, generator, documentation-generator, documentation-tool, documentation-dumper, api-documentation, python, python3, docs, docs-generator, docstrings, docstring, docstring-documentation, pdoc, hacktoberfest |
| has_wiki | ні |
| homepage | https://pdoc3.github.io/pdoc/ |
| docs_site | https://pdoc3.github.io/pdoc/ |
| has_readme | так |
| has_docs_dir | так |
| has_description | так |
Безпека
Чи міцні видимі практики безпеки й ланцюга постачання, без непослабленої пов’язаності з юрисдикціями високого ризику?
Стан безпеки
Як обчислюється оцінка
| 7.5/7.5 | Binary-Artifacts — no binaries found in the repo |
| 0/7.5 | Branch-Protection — branch protection not enabled on development/release branches |
| 0.5/2.5 | CI-Tests — 1 out of 4 merged PRs checked by a CI test -- score normalized to 2 |
| 1.2/2.5 | CII-Best-Practices — badge detected: Passing |
| 0.8/7.5 | Code-Review — Found 4/30 approved changesets -- score normalized to 1 |
| 2.5/2.5 | Contributors — project has 24 contributing companies or organizations |
| 10/10 | Dangerous-Workflow — no dangerous workflow patterns detected |
| 0/7.5 | Dependency-Update-Tool — no update tool detected |
| 5/5 | Fuzzing — project is fuzzed |
| 2.5/2.5 | Ліцензія — license file detected |
| 0/7.5 | Maintained — 0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0 |
| 0/5 | Packaging — немає даних |
| 0/5 | Pinned-Dependencies — dependency not pinned by hash detected -- score normalized to 0 |
| 0/5 | SAST — SAST tool is not run on all commits -- score normalized to 0 |
| 0/5 | Security-Policy — security policy file not detected |
| 0/7.5 | Signed-Releases — немає даних |
| 0/7.5 | Token-Permissions — detected GitHub workflow tokens with excessive permissions |
| 7.5/7.5 | Vulnerabilities — 0 existing vulnerabilities detected |
Використані вхідні дані
| source | openssf_scorecard |
| checks_evaluated | 16 |
| scorecard_version | v5.5.0 |
| checks_inconclusive | 2 |
| scorecard_aggregate | 4,1 |
Сповіщення про залежності
Як обчислюється оцінка
| 35/35 | Прямі залежності без відомих сповіщень — жодна пряма залежність не має відомих сповіщень |
| 25/25 | Непрямі залежності без відомих сповіщень — жодна непряма залежність не має відомих сповіщень |
| 0/40 | Немає задавнених сповіщень — жодне сповіщення не має дати публікації |
Використані вхідні дані
| source | osv |
| advisories | 0 |
| affected_packages | 0 |
| assessed_packages | 3 |
| unassessed_packages | 0 |
| affected_by_severity | none |
| direct_affected_packages | 0 |
Готовність до ШІ
Наскільки репозиторій оснащений для розробки та супроводу за участі ШІ-агентів? Має свідомо малу вагу (4%): агентний інструментарій — реальний сигнал супроводу, але репозиторій без нього все одно може отримати 100/100.
Контекст і настанови для агентів
Як обчислюється оцінка
| 0/45 | Інструкції для агентів — немає CLAUDE.md / AGENTS.md / правил редактора |
| 0/15 | Машиночитана документація (llms.txt) |
| 0/40 | Читабельна історія комітів — немає даних |
Використані вхідні дані
| has_llms_txt | ні |
| llms_txt_url | — |
| legible_history_share | — |
| agent_instruction_files | — |
| agent_instruction_max_bytes | — |
Цикл верифікації (збірка / тести / перевірка типів)
Як обчислюється оцінка
| 0/18 | Розгортання однією командою |
| 22/22 | Автоматизовані тести |
| 0/11 | Конфігурація лінтера / форматера |
| 0/11 | Статична перевірка типів |
| 0/10 | Відтворюване середовище |
| 0/10 | Підтверджена практика роботи з агентами — немає даних |
| 0/8 | Автоматизоване супроводження — немає даних |
| 0/10 | OpenSSF Scorecard: Pinned-Dependencies — dependency not pinned by hash detected -- score normalized to 0 |
Використані вхідні дані
| has_nix | ні |
| has_tests | так |
| lockfiles | — |
| has_dockerfile | ні |
| typed_language | ні |
| bootstrap_files | — |
| has_devcontainer | ні |
| has_linter_config | ні |
| typecheck_configs | — |
| agent_commit_share | — |
| toolchain_manifests | — |
| dependency_bot_commit_share | — |
Читабельність коду для моделей
Як обчислюється оцінка
| 0/45 | Типізований код — Python без конфігурації перевірки типів |
| 52.6/55 | Керовані розміри файлів — 2/46 файлів вихідного коду понад 60 КБ |
Використані вхідні дані
| primary_language | Python |
| largest_source_bytes | 68 628 |
| source_files_sampled | 46 |
| oversized_source_files | 2 |
Ключові факти
Докладніше
OpenSSF Scorecard 4.1 / 10
Незалежна, не прив'язана до інструментів оцінка безпеки від відкритого проєкту OpenSSF Scorecard. Кожна перевірка винагороджує практику безпеки, а не інструмент конкретного постачальника. Перевірки, які Scorecard не зміг визначити, позначено н/д і виключено з оцінки безпеки (вони ніколи не зараховуються як нуль).
| 10 | Binary-Artifacts | no binaries found in the repo |
| 0 | Branch-Protection | branch protection not enabled on development/release branches |
| 2 | CI-Tests | 1 out of 4 merged PRs checked by a CI test -- score normalized to 2 |
| 5 | CII-Best-Practices | badge detected: Passing |
| 1 | Code-Review | Found 4/30 approved changesets -- score normalized to 1 |
| 10 | Contributors | project has 24 contributing companies or organizations |
| 10 | Dangerous-Workflow | no dangerous workflow patterns detected |
| 0 | Dependency-Update-Tool | no update tool detected |
| 10 | Fuzzing | project is fuzzed |
| 10 | License | license file detected |
| 0 | Maintained | 0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0 |
| н/д | Packaging | packaging workflow not detected |
| 0 | Pinned-Dependencies | dependency not pinned by hash detected -- score normalized to 0 |
| 0 | SAST | SAST tool is not run on all commits -- score normalized to 0 |
| 0 | Security-Policy | security policy file not detected |
| н/д | Signed-Releases | no releases found |
| 0 | Token-Permissions | detected GitHub workflow tokens with excessive permissions |
| 10 | Vulnerabilities | 0 existing vulnerabilities detected |
Усі залежності 2
Повний розв'язаний набір залежностей із графа залежностей GitHub: 0 прямих і 2 непрямих (транзитивних) пакетів. Транзитивне замикання є повним, коли в репозиторії закомічено lockfile.
| Реєстр | Пакет | Версія | Зв'язок |
|---|---|---|---|
| PyPI | mako | — | непряма |
| PyPI | markdown | — | непряма |
Сповіщення про залежності 0
Встановлення pypi:pdoc3@0.11.6 тягне 3 пакетів, прямих і транзитивних: 0 мають відомі сповіщення, з них 0 — прямі залежності.
Жодне відоме сповіщення не стосується оцінених залежностей.
Сповіщення означає, що версія, записана в графі залежностей, потрапляє в уражений діапазон. Досяжність не аналізується, а граф містить піниї розробки й тестування — знахідка може стосуватися інструментів, а не поставленого коду.
Звіт у форматі JSON машиночитний
Зворотний зв’язок
Помітили щось хибне у цьому звіті або маєте чим поділитися? Неправильні вимірювання, непомічені інструменти, ідеї, запитання — усе доречно. Кожне повідомлення читається й отримує відповідь.
Оцінки — це сигнали, а не гарантії. Вони відображають публічно видимі практики на GitHub — це не аудит коду й не гарантія безпеки.
Відсутні дані виключаються, а ваги перенормовуються — нуль за відсутність ніколи не ставиться. Методологія версіонована й відкрита: метрики v2.10.0, схема v0.16.0 — повна методологія · вікі метрик.
Як окремий результат виглядає на тлі всього реєстру: сукупна статистика — PyPI.