Metadata-Version: 2.1
Name: pysymbol-llm
Version: 0.0.5
Summary: Generate manifest of public symbols win python projects w/docstrings
Home-page: https://github.com/AnswerDotAI/pysymbol-llm
Author: Hamel Husain
Author-email: hamel.husain@gmail.com
License: Apache Software License 2.0
Keywords: nbdev jupyter notebook python
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# pysymbol-llm


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

## Developer Guide

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

### Install pysymbol_llm in Development mode

``` sh
# 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](https://github.com/AnswerDotAI/pysymbol-llm):

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

or from [pypi](https://pypi.org/project/pysymbol-llm/)

``` sh
$ pip install pysymbol_llm
```

### Documentation

Documentation can be found hosted on this GitHub
[repository](https://github.com/AnswerDotAI/pysymbol-llm)’s
[pages](https://AnswerDotAI.github.io/pysymbol-llm/). Additionally you
can find package manager specific guidelines on
[conda](https://anaconda.org/AnswerDotAI/pysymbol-llm) and
[pypi](https://pypi.org/project/pysymbol-llm/) respectively.

## How to use

``` python
!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)
