structure saas with tools
This commit is contained in:
@@ -0,0 +1,109 @@
|
||||
Metadata-Version: 2.1
|
||||
Name: docstring_parser
|
||||
Version: 0.16
|
||||
Summary: Parse Python docstrings in reST, Google and Numpydoc format
|
||||
Home-page: https://github.com/rr-/docstring_parser
|
||||
License: MIT
|
||||
Author: Marcin Kurczewski
|
||||
Author-email: dash@wind.garden
|
||||
Requires-Python: >=3.6,<4.0
|
||||
Classifier: Development Status :: 4 - Beta
|
||||
Classifier: Environment :: Other Environment
|
||||
Classifier: Intended Audience :: Developers
|
||||
Classifier: License :: OSI Approved :: MIT License
|
||||
Classifier: Natural Language :: English
|
||||
Classifier: Operating System :: OS Independent
|
||||
Classifier: Programming Language :: Python :: 3
|
||||
Classifier: Programming Language :: Python :: 3.6
|
||||
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: Topic :: Documentation :: Sphinx
|
||||
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
||||
Classifier: Topic :: Text Processing :: Markup
|
||||
Project-URL: Repository, https://github.com/rr-/docstring_parser
|
||||
Description-Content-Type: text/markdown
|
||||
|
||||
docstring_parser
|
||||
================
|
||||
|
||||
[](https://github.com/rr-/docstring_parser/actions/workflows/build.yml)
|
||||
|
||||
Parse Python docstrings. Currently support ReST, Google, Numpydoc-style and
|
||||
Epydoc docstrings.
|
||||
|
||||
Example usage:
|
||||
|
||||
```python
|
||||
>>> from docstring_parser import parse
|
||||
>>>
|
||||
>>>
|
||||
>>> docstring = parse(
|
||||
... '''
|
||||
... Short description
|
||||
...
|
||||
... Long description spanning multiple lines
|
||||
... - First line
|
||||
... - Second line
|
||||
... - Third line
|
||||
...
|
||||
... :param name: description 1
|
||||
... :param int priority: description 2
|
||||
... :param str sender: description 3
|
||||
... :raises ValueError: if name is invalid
|
||||
... ''')
|
||||
>>>
|
||||
>>> docstring.long_description
|
||||
'Long description spanning multiple lines\n- First line\n- Second line\n- Third line'
|
||||
>>> docstring.params[1].arg_name
|
||||
'priority'
|
||||
>>> docstring.raises[0].type_name
|
||||
'ValueError'
|
||||
```
|
||||
|
||||
Read [API Documentation](https://rr-.github.io/docstring_parser/).
|
||||
|
||||
# Installation
|
||||
|
||||
Installation using pip
|
||||
|
||||
```shell
|
||||
pip install docstring_parser
|
||||
|
||||
# or if you want to install it in a virtual environment
|
||||
|
||||
python -m venv venv # create environment
|
||||
source venv/bin/activate # activate environment
|
||||
python -m pip install docstring_parser
|
||||
```
|
||||
|
||||
Installation using conda
|
||||
|
||||
|
||||
1. Download and install miniconda or anaconda
|
||||
2. Install the package from the conda-forge channel via:
|
||||
- `conda install -c conda-forge docstring_parser`
|
||||
- or create a new conda environment via `conda create -n my-new-environment -c conda-forge docstring_parser`
|
||||
|
||||
|
||||
# Contributing
|
||||
|
||||
To set up the project:
|
||||
```sh
|
||||
pip install --user poetry
|
||||
|
||||
git clone https://github.com/rr-/docstring_parser.git
|
||||
cd docstring_parser
|
||||
|
||||
poetry install
|
||||
poetry run pre-commit install
|
||||
```
|
||||
|
||||
To run tests:
|
||||
```
|
||||
poetry run pytest
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user