|Build Status| |codecov| |Requirements Status| |PyPi version| |PyPI pyversions| |PyPI status| |HitCount|
This project encourages an exploration into the limits of decorators in
Python. While decorators might by new to beginners, they are an
extremely useful feature of the language. They can be similar to Lisp
Macros, but without changes to the AST. Great decorators from this
packages are @animated and @writing. This repository is made
from scratch, just using Python’s Standard Library, no dependency!
Using as decorator and mixed with context-managers |animation|
Using with nested context-managers |context-manager|
Another project mine called
MAL <https://www.github.com/ryukinix/mal>__ uses the decorating
package —- basically a command line interface for
MyAnimeList <https://myanimelist.net/>__. The decorator @writing can
be used by just adding 3 lines of code! The behavior is a retro
typing-like computer. Check out the awesome effect:
|asciicast|
More examples are covered on my personal blog post about
decorating <http://manoel.tk/decorating>__.
Currently public decorators on the API of decorators decorating:
Mostly decorators has a pretty consistent usage, but for now only
animated and writing has support to use as contextmanagers
using the with syntax.
Supported Python versions:
You can install the last release on
PyPI <https://pypi.python.org/pypi/decorating/>__ by calling:
.. code:: shell
pip install --user decorating
If you want get the last development version install directly by the git repository:
.. code:: shell
pip install --user git+https://www.github.com/ryukinix/decorating
We have a published package on Arch Linux <https://aur.archlinux.org/packages/python-decorating/>__,which
you can install using your favorite AUR Helper, like pacaur or
yaourt:
.. code:: shell
yaourt -S python-decorating
Though since the version 0.6 we have support for Python2.7, an AUR
package for Python2 was not made yet. Fill a issue if you have interest
on that :). Thanks to Maxim Kuznetsov <https://github.com/mkuznets>__
which implemented the necessary changes to make compatible with Python2!
|PyPi License|
MIT <LICENSE>__
Because good things need to be free.
.. |Build Status| image:: https://travis-ci.org/ryukinix/decorating.svg?branch=master :target: https://travis-ci.org/ryukinix/decorating .. |codecov| image:: https://codecov.io/gh/ryukinix/decorating/branch/master/graph/badge.svg :target: https://codecov.io/gh/ryukinix/decorating .. |Requirements Status| image:: https://requires.io/github/ryukinix/decorating/requirements.svg?branch=master :target: https://requires.io/github/ryukinix/decorating/requirements/?branch=master .. |PyPi version| image:: https://img.shields.io/pypi/v/decorating.svg :target: https://pypi.python.org/pypi/decorating/ .. |PyPI pyversions| image:: https://img.shields.io/pypi/pyversions/decorating.svg :target: https://pypi.python.org/pypi/decorating/ .. |PyPI status| image:: https://img.shields.io/pypi/status/decorating.svg :target: https://pypi.python.org/pypi/decorating/ .. |HitCount| image:: https://hitt.herokuapp.com/ryukinix/decorating.svg :target: https://github.com/ryukinix/decorating .. |animation| image:: https://i.imgur.com/hjkNvEE.gif .. |context-manager| image:: https://i.imgur.com/EeVnDyy.gif .. |asciicast| image:: https://asciinema.org/a/ctt1rozymvsqmeipc1zrqhsxb.png :target: https://asciinema.org/a/ctt1rozymvsqmeipc1zrqhsxb .. |PyPi License| image:: https://img.shields.io/pypi/l/decorating.svg :target: https://pypi.python.org/pypi/decorating/
FAQs
A useful collection of decorators (focused in animation)
We found that decorating demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Elastic’s return to open source with the AGPL license has been met with skepticism, as many developers see it as a strategic move rather than a genuine effort to restore user trust and freedoms.
Security News
A new "revival hijack" supply chain attack targets deleted Python packages, with an estimated 22K packages at risk. Socket can detect and block hijacked packages that have added malicious code.
Product
We're introducing a new Analytics feature in the Socket dashboard so you can view changes in your organization's and repositories' alerts over time.