pysymbol-llm

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 pysymbol_llm in Development mode

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

# make changes under nbs/ directory
# ...

# compile to have changes apply to pysymbol_llm
$ nbdev_prepare

Usage

Installation

Install latest from the GitHub repository:

$ pip install git+https://github.com/AnswerDotAI/pysymbol-llm.git

or from pypi

$ pip install pysymbol_llm

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: True)
  --output_file OUTPUT_FILE  The output file (default: filelist.md)