Generate manifest of public symbols win python projects w/docstrings
Project description
pysymbol-llm
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)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pysymbol-llm-0.0.5.tar.gz
(9.8 kB
view details)
Built Distribution
File details
Details for the file pysymbol-llm-0.0.5.tar.gz
.
File metadata
- Download URL: pysymbol-llm-0.0.5.tar.gz
- Upload date:
- Size: 9.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 579d0d3d37ed391f228aa8cebc97792b790769672605a7f993b5813734d426b4 |
|
MD5 | 62177e30e708aa23ac796316cfc7a422 |
|
BLAKE2b-256 | c0b7146b3b574f85bb635546af1556a7d0c3d55bd70a64ca08e38efa15cab219 |
File details
Details for the file pysymbol_llm-0.0.5-py3-none-any.whl
.
File metadata
- Download URL: pysymbol_llm-0.0.5-py3-none-any.whl
- Upload date:
- Size: 9.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d37db0d94d70fa0902065c77df463169e31fa388cfbf4f88c0495b93e2445aa6 |
|
MD5 | a81377859662844923be62cb3f3c6846 |
|
BLAKE2b-256 | 44cfc12f9fd32a13ad4fcd31e5e1c58e9f2a62505403f9c71117d728f23d3cf0 |