Security News
Research
Data Theft Repackaged: A Case Study in Malicious Wrapper Packages on npm
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Read Latest Documentation - Browse GitHub Code Repository
pdocs
is a library and a command line program to discover the public
interface of a Python module or package. The pdocs
script can be used to
generate Markdown or HTML of a module's public interface, or it can be used
to run an HTTP server that serves generated HTML for installed modules.
pdocs
is an MIT Licensed fork of pdoc's original implementation by Andrew Gallant (@BurntSushi).
with the goal of staying true to the original vision layed out by the project's creator.
NOTE: For most projects, the best way to use pdocs
is using portray.
__pdocs__
can be used in your module to
document any identifier in your public interface.pdocs
respects your __all__
variable when present.pdocs
will automatically link identifiers in your docstrings to its
corresponding documentation.pdocs
is run as an HTTP server, external linking is supported between
packages.pdocs
HTTP server will cache generated documentation and automatically
regenerate it if the source code has been updated.The above features are explained in more detail in pdocs's documentation.
pdocs
is compatible with Python 3.6 and newer.
The following guides should get you up using pdocs in no time:
pip3 install pdocs
within your projects virtual environment.pdocs server YOUR_MODULES
to test and pdocs as_html YOUR_MODULES
to generate HTML.Below is a running list of intentional differences between pdoc and pdocs:
The original pdoc followed the Unlicense license, and as such so does the initial commit to this fork here. Unlicense is fully compatible with MIT, and the reason for the switch going forward is because MIT is a more standard and well-known license.
As seen by that commit, I chose to fork with fresh history, as the project is very old (2013) and I felt many of the commits that happened in the past might, instead of helping to debug issues, lead to red herrings due to the many changes that have happened in the Python eco-system since that time. If you desire to see the complete history for any reason, it remains available on the original pdoc repository.
pdocs
?I created pdocs
to help power portray while staying true to the original vision of pdoc
and maintain
MIT license compatibility. In the end I created it to help power better documentation websites for Python projects.
I hope you, too, find pdocs
useful!
~Timothy Crosley
FAQs
A simple program and library to auto generate API documentation for Python modules.
We found that pdocs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.