Minimalistic Python documentation for dendrophiles.
treedoc prints minimalistic Python documentation in a tree structure, aiming to hit the sweet spot between detailed information about a single object and superficial information about object attributes.
treedoc is great for:
- Getting an overview of a package without endlessly scrolling through a website.
- Searching through documentation.
- Printing essential information about different Python objects.
Installation
Install from Python Package Index (PyPI) using pip install treedoc.
Usage
treedoc can be used directly through the command-line interface,
or interactively in a Python shell or Jupyter notebook. For more information
about arguments, see treedoc --help or help(treedoc).
Command-line interface
Python shell and notebooks
treedoc can be imported and used just like any other package, e.g. in an interactive Python interpreter session or a Jupyter notebook.
Interpreter
Jupyter notebook
Contributing
Contributions are welcome. If you wish to work on a problem, please create a pull request to get feedback. We aim for:
- Zero dependencies, but dependencies for testing are ok.
- Idiomatic, clean Python code. Readability matters.
- Thorough testing and code formatting, see
.travis.ymlfor commands run by continuous integration.
Metadata
Release files for treedoc 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| treedoc-1.0.0.tar.gz | 17.6 kB | Without provenance | Details for treedoc-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| treedoc-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for treedoc-1.0.0-py3-none-any.whl |
Total release size: 38.0 kB
Release files / treedoc-1.0.0.tar.gz
| Download URL | treedoc-1.0.0.tar.gz |
|---|---|
| Size | 17.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e462614ee6529b8fddea1d3d745a376021ca5bcbb985828b9b6be15e57bd14dd
|
|
BLAKE2b-256 checksum How to use checksums |
65f4b32de50f62b700fc826f4bbebb5c08081f41c7e045109172d463588aa825
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.1
|
Release files / treedoc-1.0.0-py3-none-any.whl
| Download URL | treedoc-1.0.0-py3-none-any.whl |
|---|---|
| Size | 20.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ce2a121ce05aa90893d13227a0764d2a05e38e0e79fbf1fb9b05da4c03b26efb
|
|
BLAKE2b-256 checksum How to use checksums |
18f0544138651afaa842db0aec64cf94d54521e1b209617ee6d07181659ca590
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.1
|
Security for treedoc 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.