<p align="center">
<a href="https://github.com/wemake-services/wemake-python-styleguide" alt="wemake-python-styleguide" >
<img src="https://img.shields.io/badge/style-wemake-000000.svg" /></a>
<a href="https://beartype.rtfd.io" alt="bear-ified" >
<img src="https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg" /></a>
<a href="https://gitlab.com/braniii/decorit/pipelines" alt="Gitlab pipeline status" >
<img src="https://img.shields.io/gitlab/pipeline/braniii/decorit" /></a>
<a href="https://gitlab.com/braniii/decorit/-/commits/master">
<img alt="coverage report" src="https://gitlab.com/braniii/decorit/badges/master/coverage.svg" /></a>
<a href="https://pypi.org/project/decorit" alt="PyPI" >
<img src="https://img.shields.io/pypi/v/decorit" /></a>
<a href="https://pepy.tech/project/decorit" alt="Downloads" >
<img src="https://pepy.tech/badge/decorit" /></a>
<a href="https://img.shields.io/pypi/pyversions/decorit" alt="PyPI - Python Version">
<img src="https://img.shields.io/pypi/pyversions/decorit" /></a>
<a href="https://gitlab.com/braniii/decorit/-/blob/master/LICENSE" alt="PyPI - License" >
<img src="https://img.shields.io/pypi/l/decorit" /></a>
<a href="https://braniii.gitlab.io/decorit" alt="Doc" >
<img src="https://img.shields.io/badge/pdoc3-Documentation-brightgreen" /></a>
</p>
# decorit
The documentation including examples can be found [here](https://braniii.gitlab.io/decorit).
This is a package with handy ready-to-use decorators for daily scripting and
maintaining packages. Decorator requests are highly appreciated, simply open
an issue.
If you want to learn how to write your own decorators I recommand to head over
to realpython and check out [this article](https://realpython.com/primer-on-python-decorators/).
In case you are looking for an wrapper to easily write decorators for your own,
you might checkout [pydecor](https://github.com/mplanchard/pydecor).
This project is in an alpha stage, hence it is neither stable nor ready for
production.
> **CAUTION**:
> Starting from version 1.0.0 API-breaking changes will be made only in major
> releases. Until then, it can be changed in every minor release
> (see [changelog](#changelog)).
## Features
Existing decorators:
- `copy_doc`: copy docstring of existing function
- `copy_doc_params`: copy parameters of docstring of existing function
- `deprecated`: print deprecated warning on call
- `alias`: give multiple names to function, e.g. short and long
- `logging`: logging call of functions
- `time`: timeing execution of function
- `run_once`: run function only once at first call
## Usage
### Installation
```python
python3 -m pip install decorit
```
### Usage
```python
import decorit
# start decorating your functions
```
## Building Documentation:
The doc is based on [pdoc](https://pdoc3.github.io/pdoc/) and can be created by
simply running `bash create_doc.sh` from the docs folder. For dependencies see in the
CI action.
## Similar Projects
- [pydecor](https://github.com/mplanchard/pydecor)
## Credits:
In alphabetical order:
- [realpython](https://realpython.com/)
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/braniii/decorit",
"name": "decorit",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "decorators",
"author": "braniii",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/9a/31/aa65c4eaaaa50df4aaeef93da8827f58a31e5be1eaeab21a7f4a45803a15/decorit-0.2.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://github.com/wemake-services/wemake-python-styleguide\" alt=\"wemake-python-styleguide\" >\n <img src=\"https://img.shields.io/badge/style-wemake-000000.svg\" /></a>\n <a href=\"https://beartype.rtfd.io\" alt=\"bear-ified\" >\n <img src=\"https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg\" /></a>\n <a href=\"https://gitlab.com/braniii/decorit/pipelines\" alt=\"Gitlab pipeline status\" >\n <img src=\"https://img.shields.io/gitlab/pipeline/braniii/decorit\" /></a>\n <a href=\"https://gitlab.com/braniii/decorit/-/commits/master\">\n <img alt=\"coverage report\" src=\"https://gitlab.com/braniii/decorit/badges/master/coverage.svg\" /></a>\n <a href=\"https://pypi.org/project/decorit\" alt=\"PyPI\" >\n <img src=\"https://img.shields.io/pypi/v/decorit\" /></a>\n <a href=\"https://pepy.tech/project/decorit\" alt=\"Downloads\" >\n <img src=\"https://pepy.tech/badge/decorit\" /></a>\n <a href=\"https://img.shields.io/pypi/pyversions/decorit\" alt=\"PyPI - Python Version\">\n <img src=\"https://img.shields.io/pypi/pyversions/decorit\" /></a>\n <a href=\"https://gitlab.com/braniii/decorit/-/blob/master/LICENSE\" alt=\"PyPI - License\" >\n <img src=\"https://img.shields.io/pypi/l/decorit\" /></a>\n <a href=\"https://braniii.gitlab.io/decorit\" alt=\"Doc\" >\n <img src=\"https://img.shields.io/badge/pdoc3-Documentation-brightgreen\" /></a>\n</p>\n\n\n# decorit\nThe documentation including examples can be found [here](https://braniii.gitlab.io/decorit).\n\nThis is a package with handy ready-to-use decorators for daily scripting and\nmaintaining packages. Decorator requests are highly appreciated, simply open\nan issue.\n\nIf you want to learn how to write your own decorators I recommand to head over\nto realpython and check out [this article](https://realpython.com/primer-on-python-decorators/).\nIn case you are looking for an wrapper to easily write decorators for your own,\nyou might checkout [pydecor](https://github.com/mplanchard/pydecor).\n\nThis project is in an alpha stage, hence it is neither stable nor ready for\nproduction.\n> **CAUTION**:\n> Starting from version 1.0.0 API-breaking changes will be made only in major\n> releases. Until then, it can be changed in every minor release\n> (see [changelog](#changelog)).\n\n## Features\n\nExisting decorators:\n- `copy_doc`: copy docstring of existing function\n- `copy_doc_params`: copy parameters of docstring of existing function\n- `deprecated`: print deprecated warning on call\n- `alias`: give multiple names to function, e.g. short and long\n- `logging`: logging call of functions\n- `time`: timeing execution of function\n- `run_once`: run function only once at first call\n\n\n## Usage\n\n### Installation\n\n```python\npython3 -m pip install decorit\n```\n\n### Usage\n\n```python\nimport decorit\n\n# start decorating your functions\n```\n\n## Building Documentation:\n\nThe doc is based on [pdoc](https://pdoc3.github.io/pdoc/) and can be created by\nsimply running `bash create_doc.sh` from the docs folder. For dependencies see in the\nCI action.\n\n## Similar Projects\n- [pydecor](https://github.com/mplanchard/pydecor)\n\n## Credits:\n\nIn alphabetical order:\n- [realpython](https://realpython.com/)\n\n\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "Handy ready-to-use decorators.",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://gitlab.com/braniii/decorit"
},
"split_keywords": [
"decorators"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b47efde4910d15ba7c05feb25d293434db2b61ee5cea5f50827cdf25ddf96b37",
"md5": "5ed60cc55f3f0373483d301dfe2a2aa4",
"sha256": "b1acdf52d9713199e357166d3f8a50317cbea78559a2dbbc6399ce9385a0bc78"
},
"downloads": -1,
"filename": "decorit-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5ed60cc55f3f0373483d301dfe2a2aa4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6360,
"upload_time": "2022-04-07T11:15:12",
"upload_time_iso_8601": "2022-04-07T11:15:12.705852Z",
"url": "https://files.pythonhosted.org/packages/b4/7e/fde4910d15ba7c05feb25d293434db2b61ee5cea5f50827cdf25ddf96b37/decorit-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9a31aa65c4eaaaa50df4aaeef93da8827f58a31e5be1eaeab21a7f4a45803a15",
"md5": "b758ccd53e8908e5ac506f8dda4a5679",
"sha256": "67280fdfb47f9d503c62bdfcc4b22903c43f6bcd2e2f4cd22dd7ee4f2f23e52e"
},
"downloads": -1,
"filename": "decorit-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "b758ccd53e8908e5ac506f8dda4a5679",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7663,
"upload_time": "2022-04-07T11:15:14",
"upload_time_iso_8601": "2022-04-07T11:15:14.009385Z",
"url": "https://files.pythonhosted.org/packages/9a/31/aa65c4eaaaa50df4aaeef93da8827f58a31e5be1eaeab21a7f4a45803a15/decorit-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-04-07 11:15:14",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "braniii",
"gitlab_project": "decorit",
"lcname": "decorit"
}
JSON