# 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)
Raw data
{
"_id": null,
"home_page": "https://github.com/AnswerDotAI/pysymbol-llm",
"name": "pysymbol-llm",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "nbdev jupyter notebook python",
"author": "Hamel Husain",
"author_email": "hamel.husain@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c0/b7/146b3b574f85bb635546af1556a7d0c3d55bd70a64ca08e38efa15cab219/pysymbol-llm-0.0.5.tar.gz",
"platform": null,
"description": "# pysymbol-llm\n\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Developer Guide\n\nIf you are new to using `nbdev` here are some useful pointers to get you\nstarted.\n\n### Install pysymbol_llm in Development mode\n\n``` sh\n# make sure pysymbol_llm package is installed in development mode\n$ pip install -e .\n\n# make changes under nbs/ directory\n# ...\n\n# compile to have changes apply to pysymbol_llm\n$ nbdev_prepare\n```\n\n## Usage\n\n### Installation\n\nInstall latest from the GitHub\n[repository](https://github.com/AnswerDotAI/pysymbol-llm):\n\n``` sh\n$ pip install git+https://github.com/AnswerDotAI/pysymbol-llm.git\n```\n\nor from [pypi](https://pypi.org/project/pysymbol-llm/)\n\n``` sh\n$ pip install pysymbol_llm\n```\n\n### Documentation\n\nDocumentation can be found hosted on this GitHub\n[repository](https://github.com/AnswerDotAI/pysymbol-llm)\u2019s\n[pages](https://AnswerDotAI.github.io/pysymbol-llm/). Additionally you\ncan find package manager specific guidelines on\n[conda](https://anaconda.org/AnswerDotAI/pysymbol-llm) and\n[pypi](https://pypi.org/project/pysymbol-llm/) respectively.\n\n## How to use\n\n``` python\n!pysym2md -h\n```\n\n usage: pysym2md [-h] [--include_no_docstring] [--verbose]\n [--output_file OUTPUT_FILE]\n package_name\n\n Generate a list of symbols corresponding to a python package in a markdown\n format.\n\n positional arguments:\n package_name Name of the Python package\n\n options:\n -h, --help show this help message and exit\n --include_no_docstring Include symbols without docstrings? (default:\n False)\n --verbose Turn on verbose logging? (default: True)\n --output_file OUTPUT_FILE The output file (default: filelist.md)\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Generate manifest of public symbols win python projects w/docstrings",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/AnswerDotAI/pysymbol-llm"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "44cfc12f9fd32a13ad4fcd31e5e1c58e9f2a62505403f9c71117d728f23d3cf0",
"md5": "a81377859662844923be62cb3f3c6846",
"sha256": "d37db0d94d70fa0902065c77df463169e31fa388cfbf4f88c0495b93e2445aa6"
},
"downloads": -1,
"filename": "pysymbol_llm-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a81377859662844923be62cb3f3c6846",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9262,
"upload_time": "2024-09-14T05:38:44",
"upload_time_iso_8601": "2024-09-14T05:38:44.882822Z",
"url": "https://files.pythonhosted.org/packages/44/cf/c12f9fd32a13ad4fcd31e5e1c58e9f2a62505403f9c71117d728f23d3cf0/pysymbol_llm-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c0b7146b3b574f85bb635546af1556a7d0c3d55bd70a64ca08e38efa15cab219",
"md5": "62177e30e708aa23ac796316cfc7a422",
"sha256": "579d0d3d37ed391f228aa8cebc97792b790769672605a7f993b5813734d426b4"
},
"downloads": -1,
"filename": "pysymbol-llm-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "62177e30e708aa23ac796316cfc7a422",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9829,
"upload_time": "2024-09-14T05:38:45",
"upload_time_iso_8601": "2024-09-14T05:38:45.830197Z",
"url": "https://files.pythonhosted.org/packages/c0/b7/146b3b574f85bb635546af1556a7d0c3d55bd70a64ca08e38efa15cab219/pysymbol-llm-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-14 05:38:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AnswerDotAI",
"github_project": "pysymbol-llm",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pysymbol-llm"
}
JSON
