structure saas with tools
This commit is contained in:
@@ -0,0 +1 @@
|
||||
pip
|
||||
@@ -0,0 +1,21 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2018 Marcin Kurczewski
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -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
|
||||
```
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
docstring_parser-0.16.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||
docstring_parser-0.16.dist-info/LICENSE.md,sha256=3-UUozeuhBer0xqK9we71hcrA-VDC7CD4UWJnql6Puo,1084
|
||||
docstring_parser-0.16.dist-info/METADATA,sha256=1EnPE7nuxzfewBCp7KU_-Dw9v9g8mNwHSLhGeIsHZv0,3031
|
||||
docstring_parser-0.16.dist-info/RECORD,,
|
||||
docstring_parser-0.16.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
|
||||
docstring_parser/__init__.py,sha256=78WKoStdo7zvCcEU1Sm2zLvU_BRGKyTYjlScFEB14nk,695
|
||||
docstring_parser/__pycache__/__init__.cpython-310.pyc,,
|
||||
docstring_parser/__pycache__/attrdoc.cpython-310.pyc,,
|
||||
docstring_parser/__pycache__/common.cpython-310.pyc,,
|
||||
docstring_parser/__pycache__/epydoc.cpython-310.pyc,,
|
||||
docstring_parser/__pycache__/google.cpython-310.pyc,,
|
||||
docstring_parser/__pycache__/numpydoc.cpython-310.pyc,,
|
||||
docstring_parser/__pycache__/parser.cpython-310.pyc,,
|
||||
docstring_parser/__pycache__/rest.cpython-310.pyc,,
|
||||
docstring_parser/__pycache__/util.cpython-310.pyc,,
|
||||
docstring_parser/attrdoc.py,sha256=ZYMM5BIULr7FzZVHx-kBMLpG5Q3YKSzbBBJg5qk3cwk,4440
|
||||
docstring_parser/common.py,sha256=isfQPfuz4Kor4dxF4MXpju52SNmbvE0rd44n4PX2Y4o,6319
|
||||
docstring_parser/epydoc.py,sha256=kv62jQGMPkNtzPYgwu_vbXApIsGDsPIyTcuBsNYEfz8,8926
|
||||
docstring_parser/google.py,sha256=ZXPPJYRljl_uj1YqD6ZW_KZj_1AjmkdGP4iZqNkJhMs,13308
|
||||
docstring_parser/numpydoc.py,sha256=t9K4tYKN1RADiOS9TDUyrZy821lLrptaIHuahqEDeJE,15983
|
||||
docstring_parser/parser.py,sha256=AB-R7X36siUZ1rqRQC3jtZKgAQJnkUGdPDjRJb54y9k,2938
|
||||
docstring_parser/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
|
||||
docstring_parser/rest.py,sha256=FIOAEQUFW8z77RoF5oXfOJFI_LhsI_FuUAdLgWw5lGs,8291
|
||||
docstring_parser/tests/__init__.py,sha256=6VULghkufHkqtZfyiBamwZQNBA3z7f4TMEcBclUqTKE,34
|
||||
docstring_parser/tests/__pycache__/__init__.cpython-310.pyc,,
|
||||
docstring_parser/tests/__pycache__/_pydoctor.cpython-310.pyc,,
|
||||
docstring_parser/tests/__pycache__/test_epydoc.cpython-310.pyc,,
|
||||
docstring_parser/tests/__pycache__/test_google.cpython-310.pyc,,
|
||||
docstring_parser/tests/__pycache__/test_numpydoc.cpython-310.pyc,,
|
||||
docstring_parser/tests/__pycache__/test_parse_from_object.cpython-310.pyc,,
|
||||
docstring_parser/tests/__pycache__/test_parser.cpython-310.pyc,,
|
||||
docstring_parser/tests/__pycache__/test_rest.cpython-310.pyc,,
|
||||
docstring_parser/tests/__pycache__/test_util.cpython-310.pyc,,
|
||||
docstring_parser/tests/_pydoctor.py,sha256=nosAlcm_ovpetXTWnrLewqnP4Ea7pM_xbABAspBivcc,770
|
||||
docstring_parser/tests/test_epydoc.py,sha256=wpcgNhTEObYRN1x628POKgUj2q7nPVlDMJHtlISpZ3o,19096
|
||||
docstring_parser/tests/test_google.py,sha256=cNCInGobpinrGGsDzZKd1v0fPaVJ_t7iIMFjB0yrZzM,26577
|
||||
docstring_parser/tests/test_numpydoc.py,sha256=KWgkiBEJ54NzkPMgeIlATju2idDR_I5FPltKGDZlXTU,28987
|
||||
docstring_parser/tests/test_parse_from_object.py,sha256=n6zM9z7xSOjCl8Y9IDKWFul6Kk06XgNwfFVHzvK46xk,3823
|
||||
docstring_parser/tests/test_parser.py,sha256=mZ2PeTxtHmVacyLLMszEduuEJ6691c9WHvqpr36q59Y,6699
|
||||
docstring_parser/tests/test_rest.py,sha256=YjPahfB4QUqtGXe2rEFxzxzx7S8xaBrsRykWm7ZKGXQ,15194
|
||||
docstring_parser/tests/test_util.py,sha256=rN8vMUKfyMmKdDxKV6RrjPXPPQclmX7wcN6aSrj4NFI,1739
|
||||
docstring_parser/util.py,sha256=SQ9IKj70j9jVfNDeFKUFWcK73oxGSfeE1mRsB6ReU10,4507
|
||||
@@ -0,0 +1,4 @@
|
||||
Wheel-Version: 1.0
|
||||
Generator: poetry-core 1.9.0
|
||||
Root-Is-Purelib: true
|
||||
Tag: py3-none-any
|
||||
Reference in New Issue
Block a user