pytkdocs 0.1.0

Load Python objects documentation.

pytkdocs

Load Python objects documentation.

Requirements

pytkdocs requires Python 3.6 or above.

To install Python 3.6, I recommend using pyenv.

# install pyenv
git clone https://github.com/pyenv/pyenv ~/.pyenv

# setup pyenv (you should also put these three lines in .bashrc or similar)
export PATH="${HOME}/.pyenv/bin:${PATH}"
export PYENV_ROOT="${HOME}/.pyenv"
eval "$(pyenv init -)"

# install Python 3.6
pyenv install 3.6.8

# make it available globally
pyenv global system 3.6.8

Installation

With pip:

python3.6 -m pip install pytkdocs

With pipx:

python3.6 -m pip install --user pipx

pipx install --python python3.6 pytkdocs

Usage

pytkdocs accepts JSON on standard input and writes JSON on standard output.

Input format:

{
  "global_config": {},
  "objects": [
    {
      "path": "my_module.my_class",
      "config": {}
    }
  ]
}

Configuration

For now, the only configuration option available is filters, which allows you to select objects based on their name. It is a list of regular expressions. If the expression starts with an exclamation mark, it will filter out objects matching it (the exclamation mark is removed before evaluation). You shouldn't need a literal ! at the beginning of a regex (as it's not a valid character for Python objects names), but if you ever need one, you can add it in brackets: [!].*.

Every regular expression is performed against every name. It allows fine-grained filtering. Example:

• !^_: filter out every object whose name starts with _ (private/protected)
• ^__: but still select those who start with two _ (class-private)
• !^__.*__$: except those who also end with two _ (specials)

You can obviously make use of your regex-fu to reduce the number of regular expressions and make it more efficient.