Data

Tools

Indexes

Applications

Experiments

Open Source Science

pdoc

API Documentation for Python Projects

https://github.com/mitmproxy/pdoc

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    2 of 62 committers (3.2%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (7.5%) to scientific vocabulary

Keywords

api api-documentation docs docstring docstrings documentation documentation-generator documentation-tool pdoc python python3

Keywords from Contributors

distributed pypi interactive humans forhumans tensors serializer packaging ssl autograd
Last synced: 6 months ago · JSON representation

Repository

API Documentation for Python Projects

Basic Info
  • Host: GitHub
  • Owner: mitmproxy
  • License: mit-0
  • Language: Python
  • Default Branch: main
  • Homepage: https://pdoc.dev
  • Size: 5.83 MB
Statistics
  • Stars: 2,159
  • Watchers: 32
  • Forks: 200
  • Open Issues: 44
  • Releases: 0
Topics
api api-documentation docs docstring docstrings documentation documentation-generator documentation-tool pdoc python python3
Created over 12 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License Security

README.md

pdoc

pdoc documentation CI Status Code Coverage autofix.ci: yes PyPI Version Supported Python Versions

API Documentation for Python Projects.

Example

pdoc -o ./html pdoc generates this website: pdoc.dev/docs.

Installation

shell pip install pdoc

pdoc is compatible with Python 3.9 and newer.

Usage

```shell pdoc yourpythonmodule

or

pdoc ./my_project.py ```

Run pdoc pdoc to see pdoc's own documentation, run pdoc --help to view the command line flags, or check our hosted copy of the documentation.

Features

pdoc's main feature is a focus on simplicity: pdoc aims to do one thing and do it well.

  • Documentation is plain Markdown.
  • First-class support for type annotations and all other modern Python 3 features.
  • Builtin web server with live reloading.
  • Customizable HTML templates.
  • Understands numpydoc and Google-style docstrings.
  • Standalone HTML output without additional dependencies.

Under the hood...

  • pdoc will automatically link identifiers in your docstrings to their corresponding documentation.
  • pdoc respects your __all__ variable when present.
  • pdoc will traverse the abstract syntax tree to extract type annotations and docstrings from constructors as well.
  • pdoc will automatically try to resolve type annotation string literals as forward references.
  • pdoc will use inheritance to resolve type annotations and docstrings for class members.

If you have substantially more complex documentation needs, we recommend using Sphinx!

Contributing

As an open source project, pdoc welcomes contributions of all forms.

Dev Guide

pdoc vs. pdoc3

This project is not associated with "pdoc3", which often falsely assumes our name. Quoting @BurntSushi, the original author of pdoc:

I'm pretty disgusted that someone has taken a project I built, relicensed it, attempted to erase its entry on the Python Wiki, released it under effectively the same name and, worst of all, associated it with Nazi symbols.

Source: https://github.com/pdoc3/pdoc/issues/64

In contrast, the pdoc project strives to uphold a healthy community where everyone is treated with respect. Everyone is welcome to contribute as long as they adhere to basic civility. We expressly distance ourselves from the use of Nazi symbols and ideology.

The pdoc project was originally created by Andrew Gallant and is currently maintained by Maximilian Hils.

Owner

  • Name: mitmproxy
  • Login: mitmproxy
  • Kind: organization

GitHub Events

Total
  • Issues event: 60
  • Watch event: 215
  • Delete event: 6
  • Issue comment event: 106
  • Push event: 27
  • Pull request review event: 27
  • Pull request review comment event: 12
  • Pull request event: 50
  • Fork event: 16
  • Create event: 12
Last Year
  • Issues event: 60
  • Watch event: 215
  • Delete event: 6
  • Issue comment event: 106
  • Push event: 27
  • Pull request review event: 27
  • Pull request review comment event: 12
  • Pull request event: 50
  • Fork event: 16
  • Create event: 12

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 1,002
  • Total Committers: 62
  • Avg Commits per committer: 16.161
  • Development Distribution Score (DDS): 0.397
Past Year
  • Commits: 77
  • Committers: 15
  • Avg Commits per committer: 5.133
  • Development Distribution Score (DDS): 0.39
Top Committers
Name Email Commits
Maximilian Hils g****t@m****m 604
Andrew Gallant j****m@g****m 144
dependabot[bot] 4****] 89
Aldo Cortesi a****o@c****i 37
Erik Cederstrand e****k@c****k 12
francois joubert f****t@g****m 7
Max Rossmannek m****k@u****h 7
pdoc release bot g****t@m****m 6
Kernc k****e@g****m 5
Yannick Duchêne y****e@y****r 5
zmoon z****2@g****m 5
autofix-ci[bot] 1****] 4
Andrew Gallant A****t@t****u 4
EKC (Erik Cederstrand) e****c@n****m 3
Felix Uhl i****t 3
Crozzers c****s@g****m 3
Jayson Vantuyl j****n@a****y 3
Kailash Nadh k****h@g****m 3
Mick Koch m****k@k****o 3
Vinay Sajip v****p@y****k 3
tmeyier 9****r 3
Denise Draper d****d@a****g 2
Erik Dominguez e****3@g****m 2
Jason Black j****b@v****m 2
Jonathan Jin j****n 2
Jonathan Striebel j****l 2
Mickaël Schoentgen c****t@t****r 2
sitic s****c 2
cclauss c****s@b****h 2
Alexandre Detiste a****e@g****m 1
and 32 more...
Committer Domains (Top 20 + Academic)
maximilianhils.com: 2 hotmail.co.uk: 2 corte.si: 1 cederstrand.dk: 1 uzh.ch: 1 tufts.edu: 1 novozymes.com: 1 aggressive.ly: 1 kochm.co: 1 yahoo.co.uk: 1 acm.org: 1 voicebox.com: 1 tiger-222.fr: 1 bluewin.ch: 1 utdallas.edu: 1 impinj.com: 1 techstormpc.com: 1 djinnit.com: 1 outlook.com.au: 1 iress.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 163
  • Total pull requests: 267
  • Average time to close issues: 3 months
  • Average time to close pull requests: 5 days
  • Total issue authors: 121
  • Total pull request authors: 38
  • Average comments per issue: 2.6
  • Average comments per pull request: 0.75
  • Merged pull requests: 229
  • Bot issues: 0
  • Bot pull requests: 113
Past Year
  • Issues: 50
  • Pull requests: 62
  • Average time to close issues: 2 days
  • Average time to close pull requests: 3 days
  • Issue authors: 38
  • Pull request authors: 13
  • Average comments per issue: 1.08
  • Average comments per pull request: 0.79
  • Merged pull requests: 52
  • Bot issues: 0
  • Bot pull requests: 11
View more stats
Top Authors
Issue Authors
  • elliot-100 (4)
  • shner-elmo (4)
  • JCGoran (4)
  • lovetheguitar (4)
  • mrossinek (3)
  • HackXIt (3)
  • aaronsteers (3)
  • mjbaldwin (3)
  • adigitoleo (3)
  • mdaeron (2)
  • meghprkh (2)
  • stikpet (2)
  • nxtlo (2)
  • khusmann (2)
  • hhoppe (2)
Pull Request Authors
  • dependabot[bot] (113)
  • mhils (86)
  • jinnovation (6)
  • iFreilicht (6)
  • tmeyier (5)
  • vsajip (3)
  • Steve-Tech (2)
  • earshinov (2)
  • meghprkh (2)
  • CodeMelted (2)
  • mrossinek (2)
  • frankharkins (2)
  • adhintz (2)
  • elliot-100 (2)
  • tobiscode (2)
Top Labels
Issue Labels
bug (85) enhancement (70) upstream (2) help wanted (1)
Pull Request Labels
dependencies (113) python (87) github_actions (25)

Packages

  • Total packages: 3
  • Total downloads:
    • pypi 1,478,879 last-month
  • Total docker downloads: 559,135
  • Total dependent packages: 193
    (may contain duplicates)
  • Total dependent repositories: 390
    (may contain duplicates)
  • Total versions: 199
  • Total maintainers: 4
  • Total advisories: 1
pypi.org: pdoc

API Documentation for Python Projects

  • Versions: 113
  • Dependent Packages: 192
  • Dependent Repositories: 388
  • Downloads: 1,478,879 Last month
  • Docker Downloads: 559,135
Rankings
Dependent packages count: 0.2%
Dependent repos count: 0.7%
Downloads: 0.8%
Average: 1.5%
Stargazers count: 1.7%
Docker downloads count: 2.3%
Forks count: 3.6%
Maintainers (4)
cortesi mhils burntsushi kriechi
Advisories (1)
Last synced: 6 months ago
proxy.golang.org: github.com/mitmproxy/pdoc
  • Versions: 75
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 6.5%
Average: 6.7%
Dependent repos count: 7.0%
Last synced: 6 months ago
conda-forge.org: pdoc

see our main page for more information

  • Homepage: https://pdoc.dev/
  • License: Unlicense
  • Latest release: 12.3.0
    published over 3 years ago
  • Versions: 11
  • Dependent Packages: 1
  • Dependent Repositories: 2
Rankings
Stargazers count: 10.4%
Forks count: 13.8%
Average: 18.3%
Dependent repos count: 20.2%
Dependent packages count: 29.0%
Last synced: 6 months ago

Dependencies

requirements-dev.txt pypi
  • Jinja2 ==3.1.1
  • MarkupSafe ==2.1.1
  • Pygments ==2.12.0
  • attrs ==21.4.0
  • coverage ==6.3.2
  • distlib ==0.3.4
  • filelock ==3.6.0
  • flake8 ==4.0.1
  • hypothesis ==6.45.0
  • iniconfig ==1.1.1
  • mccabe ==0.6.1
  • mypy ==0.942
  • mypy-extensions ==0.4.3
  • packaging ==21.3
  • pip ==22.0.4
  • platformdirs ==2.5.2
  • pluggy ==1.0.0
  • py ==1.11.0
  • pycodestyle ==2.8.0
  • pyflakes ==2.4.0
  • pyparsing ==3.0.8
  • pytest ==7.1.2
  • pytest-cov ==3.0.0
  • pytest-timeout ==2.1.0
  • setuptools ==58.1.0
  • six ==1.16.0
  • sortedcontainers ==2.4.0
  • toml ==0.10.2
  • tomli ==2.0.1
  • tox ==3.25.0
  • typing_extensions ==4.2.0
  • virtualenv ==20.14.1
.github/workflows/autofix.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • autofix-ci/action 8bc06253bec489732e5f9c52884c7cace15c0160 composite
  • mhils/add-pr-ref-in-changelog main composite
.github/workflows/docs.yml actions
  • actions/checkout v3 composite
  • actions/deploy-pages v1 composite
  • actions/setup-python v4 composite
  • actions/upload-pages-artifact v1 composite
.github/workflows/main.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • install-pinned/build 80d41abb0995d6d957a562f30fc70c39fca61b6f composite
  • install-pinned/setuptools 0d74f5e9d09987231503f9b1c8e6c918e1c45fb8 composite
  • install-pinned/tox 952fc3745065aff6bad482017c5a81eda47d00f0 composite
  • install-pinned/wheel 53c86096b91671b8bb138a78a963c1e88295a5a3 composite
  • re-actors/alls-green 05ac9388f0aebcb5727afa17fcccfecd6f8ec5fe composite
pyproject.toml pypi
  • Jinja2 >= 2.11.0
  • MarkupSafe *
  • astunparse python_version<'3.9'
  • pygments >= 2.12.0