docstring_parser_fork
================
This is a fork of [docstring_parser](https://github.com/rr-/docstring_parser).
This fork fixes bugs that the upstream library has not fixed, and it also
offers additional functionalities. To inspect the difference between this
fort and the upstream, go to [CHANGELOG.md](./CHANGELOG.md) and read the
entries that start with "(Fork)".
------
[](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_fork
# 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_fork
```
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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/jsh9/docstring_parser_fork",
"name": "docstring-parser-fork",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Marcin Kurczewski",
"author_email": "dash@wind.garden",
"download_url": "https://files.pythonhosted.org/packages/fc/ad/84439fbde3c064202c39bc794314257a1cbc24b19d24f8fa28d50eedfbe5/docstring_parser_fork-0.0.8.tar.gz",
"platform": null,
"description": "docstring_parser_fork\n================\n\nThis is a fork of [docstring_parser](https://github.com/rr-/docstring_parser).\n\nThis fork fixes bugs that the upstream library has not fixed, and it also\noffers additional functionalities. To inspect the difference between this\nfort and the upstream, go to [CHANGELOG.md](./CHANGELOG.md) and read the\nentries that start with \"(Fork)\".\n\n------\n\n[](https://github.com/rr-/docstring_parser/actions/workflows/build.yml)\n\nParse Python docstrings. Currently support ReST, Google, Numpydoc-style and\nEpydoc docstrings.\n\nExample usage:\n\n```python\n>>> from docstring_parser import parse\n>>>\n>>>\n>>> docstring = parse(\n... '''\n... Short description\n...\n... Long description spanning multiple lines\n... - First line\n... - Second line\n... - Third line\n...\n... :param name: description 1\n... :param int priority: description 2\n... :param str sender: description 3\n... :raises ValueError: if name is invalid\n... ''')\n>>>\n>>> docstring.long_description\n'Long description spanning multiple lines\\n- First line\\n- Second line\\n- Third line'\n>>> docstring.params[1].arg_name\n'priority'\n>>> docstring.raises[0].type_name\n'ValueError'\n```\n\nRead [API Documentation](https://rr-.github.io/docstring_parser/).\n\n# Installation\n\nInstallation using pip\n\n```shell\npip install docstring_parser_fork\n\n# or if you want to install it in a virtual environment\n\npython -m venv venv # create environment\nsource venv/bin/activate # activate environment\npython -m pip install docstring_parser_fork\n```\n\nInstallation using conda\n\n\n1. Download and install miniconda or anaconda\n2. Install the package from the conda-forge channel via:\n - `conda install -c conda-forge docstring_parser`\n - or create a new conda environment via `conda create -n my-new-environment -c conda-forge docstring_parser`\n\n\n# Contributing\n\nTo set up the project:\n```sh\npip install --user poetry\n\ngit clone https://github.com/rr-/docstring_parser.git\ncd docstring_parser\n\npoetry install\npoetry run pre-commit install\n```\n\nTo run tests:\n```\npoetry run pytest\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Parse Python docstrings in reST, Google and Numpydoc format",
"version": "0.0.8",
"project_urls": {
"Homepage": "https://github.com/jsh9/docstring_parser_fork",
"Repository": "https://github.com/jsh9/docstring_parser_fork"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f799e5ea146a10f6608a69073f9b2b5d2dd8cb746abe66560c474f9176772aaa",
"md5": "fd46ba95df78e8d81a1e22a2aabf4746",
"sha256": "88098ae01b0909b241954ad2c50c0c29ec2292223366a540bfd68332be8fd595"
},
"downloads": -1,
"filename": "docstring_parser_fork-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fd46ba95df78e8d81a1e22a2aabf4746",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 40279,
"upload_time": "2024-06-24T01:26:57",
"upload_time_iso_8601": "2024-06-24T01:26:57.846946Z",
"url": "https://files.pythonhosted.org/packages/f7/99/e5ea146a10f6608a69073f9b2b5d2dd8cb746abe66560c474f9176772aaa/docstring_parser_fork-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fcad84439fbde3c064202c39bc794314257a1cbc24b19d24f8fa28d50eedfbe5",
"md5": "98185050378fd7e91c1cb1968946591b",
"sha256": "59d3b00d42ba9f4e229a7df7e1f6fc742845f88a1190973cc33ba336a5405425"
},
"downloads": -1,
"filename": "docstring_parser_fork-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "98185050378fd7e91c1cb1968946591b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 29939,
"upload_time": "2024-06-24T01:26:59",
"upload_time_iso_8601": "2024-06-24T01:26:59.677391Z",
"url": "https://files.pythonhosted.org/packages/fc/ad/84439fbde3c064202c39bc794314257a1cbc24b19d24f8fa28d50eedfbe5/docstring_parser_fork-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-24 01:26:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jsh9",
"github_project": "docstring_parser_fork",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "docstring-parser-fork"
}
JSON
