pysym2md

Generate manifest of public symbols win python projects w/docstrings

Developer Guide

If you are new to using nbdev here are some useful pointers to get you started.

Install pysym2md in Development mode

# make sure pysym2md package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to pysym2md
$ nbdev_prepare

Usage

Installation

Install latest from the GitHub repository:

$ pip install git+https://github.com/AnswerDotAI/pysym2md.git

or from pypi

$ pip install pysym2md

Documentation

Documentation can be found hosted on this GitHub repository’s pages. Additionally you can find package manager specific guidelines on conda and pypi respectively.

How to use

!pysym2md -h

usage: pysym2md [-h] [--include_no_docstring] [--verbose]
                [--output_file OUTPUT_FILE]
                package_name

Generate a list of symbols corresponding to a python package in a markdown
format.

positional arguments:
  package_name               Name of the Python package

options:
  -h, --help                 show this help message and exit
  --include_no_docstring     Include symbols without docstrings? (default:
                             False)
  --verbose                  Turn on verbose logging? (default: False)
  --output_file OUTPUT_FILE  The output file (default: filelist.md)