Package Health Score

83 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Active

Explore Similar Packages

Popularity

Popular

GitHub Stars: 1.12K
Forks: 145
Contributors: 60

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package pdoc3, we found that it has been starred 1,122 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Jun 26, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

AGPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

We found a way for you to contribute to the project! Looks like pdoc3 is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 103
Open PR: 12
Last Release: 3 months ago
Last Commit: 3 months ago

Further analysis of the maintenance status of pdoc3 based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that pdoc3 demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 60
Funding: Yes

With more than 10 contributors for the pdoc3 repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like pdoc3 is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.9

Age: 6 years
Latest Release: 3 months ago
Dependencies: 1 Direct
Versions: 31
Maintainers: 1
Wheels: No

Readme

pdoc

Auto-generate API documentation for Python 3+ projects.

Project website

Documentation

Installation

$ pip install pdoc3

Usage

Pdoc will accept a Python module file, package directory or an import path.

$ pdoc your_project

See pdoc --help for more command-line switches and the documentation for more usage examples.

Features

Simple usage. Generate sensible API (+ prose) documentation without any special configuration.
Support for common docstrings formats (Markdown, numpydoc, Google-style docstrings), LaTeX math, and some reST directives.
Support for PEP 484 and PEP 526 type annotations.
pdoc respects __all__ when present.
Docstrings for overridden class members are inherited if unspecified.
Support for documenting module, class, and instance variables by traversing ASTs.
Automatic cross-linking of referenced identifiers.
Overriding docstrings generation with special module-level __pdoc__ dictionary.
Easily extended and customized templates.
Built-in development web server for near-instant preview of rendered docstrings.

The above features are explained in more detail in pdoc's documentation (generated with pdoc).

Development

Check CONTRIBUTING.md for hacking details.

pdoc3 dependencies

mako

FAQs

What is pdoc3?

Auto-generate API documentation for Python projects. Visit Snyk Advisor to see a full health score report for pdoc3, including popularity, security, maintenance & community analysis.

Is pdoc3 popular?

The python package pdoc3 receives a total of 72,470 weekly downloads. As such, pdoc3 popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is pdoc3 well maintained?

We found that pdoc3 demonstrated a healthy version release cadence and project activity. It has a community of 60 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is pdoc3 safe to use?

The python package pdoc3 was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 17 September-2024, at 11:04 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

pdoc3

Auto-generate API documentation for Python projects. For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Explore Similar Packages

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Non-Permissive License

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

pdoc

Installation

Usage

Features

Development

pdoc3 dependencies

FAQs

What is pdoc3?

Is pdoc3 popular?

Is pdoc3 well maintained?

Is pdoc3 safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

pdoc

Installation

Usage

Features

Development

pdoc3 dependencies

FAQs

What is pdoc3?

Is pdoc3 popular?

Is pdoc3 well maintained?

Is pdoc3 safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues