docraise

Name	docraise JSON
Version	0.1.0 JSON
	download
home_page	https://github.com/Laleee/docraise
Summary	Docraise is a linter that checks whether the docstrings contain valid "Raises" sections
upload_time	2023-07-10 11:57:23
maintainer
docs_url	None
author	Lazar Jovanovic
requires_python	>=3.8
license
keywords	lint
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Docraise

Docraise is a Python project that checks whether the docstrings in your Python code contain valid "Raises" sections.
It ensures that every exception your code raises is documented in the docstrings, and vice versa - that every exception documented in the docstrings is actually raised by the code.

## Installation

Install the project dependencies:

```bash
pip install -r requirements-dev.txt
```

## pre-commit setup

Docraise uses [pre-commit](https://pre-commit.com/) to manage git hooks. This helps to ensure that code style, tests, and other checks are run before each commit.

We use the following pre-commit plugins:

- [black](https://github.com/psf/black): Ensures our Python code adheres to the Black code style.
- [flake8](https://flake8.pycqa.org/en/latest/): Lints our Python code to catch potential bugs.
- [isort](https://pycqa.github.io/isort/): Sorts our Python imports.
- [mypy](http://mypy-lang.org/): Checks our Python code for type errors.
- [pydocstyle](http://www.pydocstyle.org/en/stable/): Checks our Python docstrings to ensure they adhere to the docstring conventions.
- [conventional commit](https://www.conventionalcommits.org/): Ensures all commit messages adhere to the Conventional Commits style.

In the project directory, install the pre-commit hooks:
```bash
pre-commit install
pre-commit install --hook-type commit-msg
```


## Usage

TODO

## Testing

TODO

```bash
pytest tests/
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Laleee/docraise",
    "name": "docraise",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "lint",
    "author": "Lazar Jovanovic",
    "author_email": "jlazar1996@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/fa/fb/4e5dfa21cd4bbd83c4e251d39035d87fb697c081a3ed00fbf759dff44f40/docraise-0.1.0.tar.gz",
    "platform": null,
    "description": "# Docraise\n\nDocraise is a Python project that checks whether the docstrings in your Python code contain valid \"Raises\" sections.\nIt ensures that every exception your code raises is documented in the docstrings, and vice versa - that every exception documented in the docstrings is actually raised by the code.\n\n## Installation\n\nInstall the project dependencies:\n\n```bash\npip install -r requirements-dev.txt\n```\n\n## pre-commit setup\n\nDocraise uses [pre-commit](https://pre-commit.com/) to manage git hooks. This helps to ensure that code style, tests, and other checks are run before each commit.\n\nWe use the following pre-commit plugins:\n\n- [black](https://github.com/psf/black): Ensures our Python code adheres to the Black code style.\n- [flake8](https://flake8.pycqa.org/en/latest/): Lints our Python code to catch potential bugs.\n- [isort](https://pycqa.github.io/isort/): Sorts our Python imports.\n- [mypy](http://mypy-lang.org/): Checks our Python code for type errors.\n- [pydocstyle](http://www.pydocstyle.org/en/stable/): Checks our Python docstrings to ensure they adhere to the docstring conventions.\n- [conventional commit](https://www.conventionalcommits.org/): Ensures all commit messages adhere to the Conventional Commits style.\n\nIn the project directory, install the pre-commit hooks:\n```bash\npre-commit install\npre-commit install --hook-type commit-msg\n```\n\n\n## Usage\n\nTODO\n\n## Testing\n\nTODO\n\n```bash\npytest tests/\n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Docraise is a linter that checks whether the docstrings contain valid \"Raises\" sections",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/Laleee/docraise",
        "Source": "https://github.com/Laleee/docraise"
    },
    "split_keywords": [
        "lint"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "65542081f59d2f301b9ba29d6c8074a9a35b58aa19a208d440a5c5d147ba1770",
                "md5": "8c359e73586460ec19cc56ac86a86223",
                "sha256": "0731cc9f9a0e21ff91630311ff5fa9639aca34be55df62b0bb2e392d519c6036"
            },
            "downloads": -1,
            "filename": "docraise-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8c359e73586460ec19cc56ac86a86223",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 6566,
            "upload_time": "2023-07-10T11:57:21",
            "upload_time_iso_8601": "2023-07-10T11:57:21.699743Z",
            "url": "https://files.pythonhosted.org/packages/65/54/2081f59d2f301b9ba29d6c8074a9a35b58aa19a208d440a5c5d147ba1770/docraise-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fafb4e5dfa21cd4bbd83c4e251d39035d87fb697c081a3ed00fbf759dff44f40",
                "md5": "9ee2ad598c327a9f21c0976d31c49e42",
                "sha256": "a2a2bf379b79756c11da1688cd4595cb7675321e4084e4dab768505a59f03cbb"
            },
            "downloads": -1,
            "filename": "docraise-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9ee2ad598c327a9f21c0976d31c49e42",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 6059,
            "upload_time": "2023-07-10T11:57:23",
            "upload_time_iso_8601": "2023-07-10T11:57:23.626001Z",
            "url": "https://files.pythonhosted.org/packages/fa/fb/4e5dfa21cd4bbd83c4e251d39035d87fb697c081a3ed00fbf759dff44f40/docraise-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-10 11:57:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Laleee",
    "github_project": "docraise",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "docraise"
}