Skip to main content
Inspect.

When documenting a library or software product written in Python, often
a README is not enough, but full-blown Sphinx is too much work or too
rigid.

Inspect is a command-line tool that will automatically document Python
code, but it returns the output as machine-readable JSON or
human-readable Markdown, so you retain full control of how to render the
documentation.

Usage: inspect [] [options]

Options: -m --markdown At what level to start headers. --include ...
--exclude ...

If you only need a single object documented (whether a function, a class
or something else), you can use the

.. raw:: html

<object>

argument:

::

# will only include documentation on `A`
inspect fixtures/example.py A

Filtering the output with ``--include`` and ``--exclude`` ensures that
your code description only contains exactly what you want it to. Some
examples:

::

# only include class methods if they've been documented
inspect fixtures/example.py --include members.documented
# only include classes
inspect fixtures/example.py --include type:class
# only document function `factorize` and class `Bean`
inspect fixtures/example.py --include name:fun,name:B
# only include documented methods on Bean
# (these two are identical)
inspect fixtures/example.py Bean --include documented
inspect fixtures/example.py --include name:Bean,members.documented

As you can see, ``.`` traverses the hierarchy and ``:`` is the value to
test against. (If you don't specify a value, we will test on presence.)

``,`` separates multiple criteria that are OR'ed together.

Todo:

- improve documentation
- unit test the filtering mechanism
- fill out missing information in the description JSON (if any)
- an ``intercalate`` utility that runs shell commands inside of ``%%``
tags in a file and replaces the tags with the standard output from
those commands

Metadata

Release files for inspected 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for inspected 0.2.0
File Size Uploaded
inspected-0.2.0.tar.gz 5.0 kB Details

Release files / inspected-0.2.0.tar.gz

Download URL inspected-0.2.0.tar.gz
Size 5.0 kB
Tags Source
SHA-256 checksum
How to use checksums
19c5b4a5af1774b2466e8e5dbbb5c81911dcd897d40ec96570b840ab8f92dadf
BLAKE2b-256 checksum
How to use checksums
85d3418a8e3bb9bfd87504500d4bc43ab58650e905722644eb66c9d7f6255597
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.2.0 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page