pdoc3 / pdoc
🐍 ➡️ 📜 Auto-generate API documentation for Python projects
pdoc3/pdoc holds a health index of 62 out of 100, placing it in the Moderate band. It scores highest on Community & Adoption (79/100) and lowest on AI Readiness (22/100). It was last updated today. A single contributor accounts for most of its recent work.
Software health index
Metrics are grouped into weighted categories on one standardized 1–100 scale. Overall starts as their weighted mean, calibrated against the distribution of the public record so bands carry percentile meaning; when public evidence triggers the High-Risk Jurisdiction Policy, the rating is adjusted and receives an At Risk ceiling of 34.
Score profile
Each axis is a category. The shape matters more than the average — a healthy subject fills the whole shape, while a spike-and-crater profile means strength in one dimension is masking risk in another.
The weighted overall 58 is calibrated to 62 on the published index scale (record calibration 2026-08-02).
Ownership
This repository is backed by an organization — shared, accountable stewardship that can outlive any single maintainer.
Package ecosystems
| Registry | Package | Version | Downloads / mo | Versions | Last publish |
|---|---|---|---|---|---|
| PyPI | pdoc3 | 0.11.6 | 276,078 | 36 | 487 days ago |
Metrics by category
Vitality
Is the project alive — is code being written and are releases shipping?
Development activity
How it's scored
| 36/36 | Push recency — last push 0 days ago |
| 1.4/36 | Commit cadence — 2/52 weeks with commits |
| 5.4/18 | Commit volume — 3 commits in the last year |
| 0/10 | OpenSSF Scorecard: Maintained — 0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0 |
Inputs used
| commits_last_year | 3 |
| human_commit_share | — |
| days_since_last_push | 0 |
| active_weeks_last_year | 2 |
Release discipline
How it's scored
| 27/27 | Ships releases — 1 releases published |
| 0/36 | Release recency — latest release 2,734 days ago |
| 12.6/27 | Release cadence — cadence unknown (single release) |
| 0/10 | OpenSSF Scorecard: Signed-Releases — no data |
Inputs used
| releases_count | 1 |
| latest_release_tag | 0.3.11 |
| releases_from_tags | no |
| days_since_latest_release | 2,734 |
| mean_days_between_releases | — |
Community & Adoption
Does the project have users, downloads, attention, and a welcoming setup for contributors?
Popularity & adoption
How it's scored
| 49.9/60 | Stars — 1,191 stars |
| 18/25 | Forks — 144 forks |
| 4.7/15 | Watchers — 8 watchers |
Inputs used
| forks | 144 |
| stars | 1,191 |
| watchers | 8 |
| growth_state | unverified |
| growth_factor_pct | 100 |
| growth_unverified_reason | no_history |
Community health
How it's scored
| 22.5/22.5 | README |
| 22.5/22.5 | License — recognized license (AGPL-3.0) |
| 18/18 | CONTRIBUTING guide |
| 0/13.5 | Code of conduct |
| 7.2/7.2 | Issue template |
| 0/6.3 | PR template |
Inputs used
| has_readme | yes |
| has_license | yes |
| readme_badges | — |
| has_contributing | yes |
| has_issue_template | yes |
| has_code_of_conduct | no |
| readme_badge_services | — |
| has_pull_request_template | no |
Ecosystem adoption (downloads)
How it's scored
| 72.5/80 | Monthly downloads — 276,078 downloads/month across pypi |
| 0/20 | Registry dependents — not reported by this ecosystem |
Inputs used
| packages | pdoc3 |
| dependents | — |
| ecosystems | pypi |
| total_downloads | — |
| monthly_downloads | 276,078 |
| unverified_packages_excluded | — |
Sustainability & Governance
Will the project survive its people — bus factor, responsiveness, who backs it, and package upkeep?
How it's scored
| 9/54 | Bus factor — 1 contributor(s) cover half of all commits |
| 9.5/22.5 | Commit distribution — top contributor authored 58% of commits |
| 13.5/13.5 | Contributor breadth — 63 contributors |
| 10/10 | OpenSSF Scorecard: Contributors — project has 24 contributing companies or organizations |
Inputs used
| bus_factor | 1 |
| contributors_sampled | 63 |
| top_contributor_share | 0.577 |
Issue & PR responsiveness
How it's scored
| 29.9/42 | Issue resolution — 71% of issues closed |
| 21.1/30 | PR acceptance — 86/122 decided PRs merged |
| 0/13 | Newcomer PR acceptance — no first-time contributor's PR decided in 30d |
| 1.5/15 | OpenSSF Scorecard: Code-Review — Found 4/30 approved changesets -- score normalized to 1 |
Inputs used
| 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 | — |
Ownership & stewardship
How it's scored
| 30/30 | Ownership backing — organization-owned |
| 0/20 | Verified domain — verified-domain status not read for this organization |
| 7.5/25 | Owner reach — 10 followers of pdoc3 |
| 15.5/25 | Track record — 2 public repos, account ~7 yr old |
Inputs used
| followers | 10 |
| owner_type | Organization |
| is_verified | — |
| owner_login | pdoc3 |
| public_repos | 2 |
| account_age_days | 2,757 |
Package maintenance
How it's scored
| 25/25 | Published & resolvable — 1 package(s) on pypi |
| 14/35 | Publish recency — latest publish 487 days ago |
| 20/20 | Version history — 36 published versions |
| 20/20 | Not deprecated — active, not deprecated or yanked |
Inputs used
| packages | pdoc3 |
| ecosystems | pypi |
| any_deprecated | no |
| min_days_since_publish | 487 |
Engineering Quality
Are baseline engineering and documentation practices in place?
Engineering practices
How it's scored
| 24/24 | CI workflows — 2 workflow(s) |
| 24/24 | Tests present |
| 0/16 | Linter config |
| 0/9.6 | Pre-commit hooks |
| 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 |
Inputs used
| has_ci | yes |
| has_tests | yes |
| has_editorconfig | no |
| has_linter_config | no |
| has_precommit_config | no |
Documentation
How it's scored
| 30/30 | README |
| 25/25 | Documentation directory |
| 15/15 | Documentation / homepage site — https://pdoc3.github.io/pdoc/ |
| 10/10 | Repository description |
| 10/10 | Topics — 15 topics |
| 0/10 | Wiki |
Inputs used
| topics | documentation, generator, documentation-generator, documentation-tool, documentation-dumper, api-documentation, python, python3, docs, docs-generator, docstrings, docstring, docstring-documentation, pdoc, hacktoberfest |
| has_wiki | no |
| homepage | https://pdoc3.github.io/pdoc/ |
| docs_site | https://pdoc3.github.io/pdoc/ |
| has_readme | yes |
| has_docs_dir | yes |
| has_description | yes |
Security
Are visible security and supply-chain practices strong, without unresolved high-risk jurisdiction exposure?
Security posture
How it's scored
| 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 — 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 — no data |
| 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 — no data |
| 0/7.5 | Token-Permissions — detected GitHub workflow tokens with excessive permissions |
| 7.5/7.5 | Vulnerabilities — 0 existing vulnerabilities detected |
Inputs used
| source | openssf_scorecard |
| checks_evaluated | 16 |
| scorecard_version | v5.5.0 |
| checks_inconclusive | 2 |
| scorecard_aggregate | 4.1 |
Dependency advisories
How it's scored
| 35/35 | Direct dependencies free of known advisories — no direct dependency carries a known advisory |
| 25/25 | Indirect dependencies free of known advisories — no indirect dependency carries a known advisory |
| 0/40 | No advisories left outstanding — no advisory carries a publication date |
Inputs used
| source | osv |
| advisories | 0 |
| affected_packages | 0 |
| assessed_packages | 3 |
| unassessed_packages | 0 |
| affected_by_severity | none |
| direct_affected_packages | 0 |
AI Readiness
How well is the repo equipped to be developed and maintained with AI coding agents? Carries a deliberately small weight (4%): agent tooling is a real maintenance signal, but a repository with none can still reach 100/100.
Agent context & guidance
How it's scored
| 0/45 | Agent instructions — no CLAUDE.md / AGENTS.md / editor rules |
| 0/15 | Machine-readable docs (llms.txt) |
| 0/40 | Legible commit history — no data |
Inputs used
| has_llms_txt | no |
| llms_txt_url | — |
| legible_history_share | — |
| agent_instruction_files | — |
| agent_instruction_max_bytes | — |
How it's scored
| 0/18 | One-command bootstrap |
| 22/22 | Automated tests |
| 0/11 | Lint / format config |
| 0/11 | Static type checking |
| 0/10 | Reproducible environment |
| 0/10 | Demonstrated agent practice — no data |
| 0/8 | Automated maintenance — no data |
| 0/10 | OpenSSF Scorecard: Pinned-Dependencies — dependency not pinned by hash detected -- score normalized to 0 |
Inputs used
| has_nix | no |
| has_tests | yes |
| lockfiles | — |
| has_dockerfile | no |
| typed_language | no |
| bootstrap_files | — |
| has_devcontainer | no |
| has_linter_config | no |
| typecheck_configs | — |
| agent_commit_share | — |
| toolchain_manifests | — |
| dependency_bot_commit_share | — |
Code legibility for models
How it's scored
| 0/45 | Type-checkable code — Python without a type-check config |
| 52.6/55 | Manageable file sizes — 2/46 source files over 60KB |
Inputs used
| primary_language | Python |
| largest_source_bytes | 68,628 |
| source_files_sampled | 46 |
| oversized_source_files | 2 |
Key facts
More detail
OpenSSF Scorecard 4.1 / 10
Independent, tool-agnostic security assessment from the open-source OpenSSF Scorecard. Each check rewards a security practice, not a specific vendor's tool. Checks Scorecard could not determine are marked n/a and excluded from the security score (never counted as zero).
| 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 |
| n/a | 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 |
| n/a | Signed-Releases | no releases found |
| 0 | Token-Permissions | detected GitHub workflow tokens with excessive permissions |
| 10 | Vulnerabilities | 0 existing vulnerabilities detected |
All dependencies 2
Full resolved dependency set from the GitHub dependency graph: 0 direct and 2 indirect (transitive) packages. The transitive closure is complete when the repository commits a lockfile.
| Registry | Package | Version | Relation |
|---|---|---|---|
| PyPI | mako | — | indirect |
| PyPI | markdown | — | indirect |
Dependency advisories 0
Installing pypi:pdoc3@0.11.6 pulls in 3 packages, direct and transitive: 0 carry known advisories, of which 0 are direct dependencies.
No known advisories affect the assessed dependencies.
An advisory means the version recorded in the dependency graph falls inside an advisory’s affected range. Reachability is not analysed, and the graph includes development and test pins — a finding may concern tooling rather than shipped software.
Raw JSON report machine-readable
Feedback
Spotted something off in this report, or have thoughts to share? Wrong measurements, missed tooling, ideas, questions — anything is welcome. Every message is read and gets a response.
Scores are signals, not warranties. They reflect publicly visible practices on GitHub — not a code audit, and not a security guarantee.
Missing data is excluded and weights renormalized, never scored as zero. Methodology is versioned and open: metrics v2.10.0, schema v0.16.0 — full methodology · metrics wiki.
How one result sits in the wider record: aggregate statistics — PyPI.