Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryukinix/decorating
decorating: Literally decorating your terminal with decorators
https://github.com/ryukinix/decorating
animation decorating decorators python terminal
Last synced: 3 days ago
JSON representation
decorating: Literally decorating your terminal with decorators
- Host: GitHub
- URL: https://github.com/ryukinix/decorating
- Owner: ryukinix
- License: mit
- Created: 2016-05-17T18:52:26.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-27T10:22:40.000Z (almost 7 years ago)
- Last Synced: 2024-10-06T16:03:36.140Z (28 days ago)
- Topics: animation, decorating, decorators, python, terminal
- Language: Python
- Homepage: http://decorating.readthedocs.io
- Size: 122 KB
- Stars: 249
- Watchers: 13
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-github-stars - ryukinix/decorating - decorating: Literally decorating your terminal with decorators (Python)
- starred-awesome - decorating - decorating: Literally decorating your terminal with decorators (Python)
README
Decorating: A Meta Repo To Decorators
=================
[](https://travis-ci.org/ryukinix/decorating)
[](https://codecov.io/gh/ryukinix/decorating)
[](https://requires.io/github/ryukinix/decorating/requirements/?branch=master)
[](https://pypi.python.org/pypi/decorating/)
[](https://pypi.python.org/pypi/decorating/)
[](https://pypi.python.org/pypi/decorating/)
[](https://github.com/ryukinix/decorating)
# Abstract
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!
# Examples
## Animated
*Using as decorator and mixed with context-managers*
*Using with nested context-managers*
## Writing
Another project mine called [MAL] uses the decorating package —-
basically a command line interface for [MyAnimeList]. 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:
[](https://asciinema.org/a/ctt1rozymvsqmeipc1zrqhsxb)
[MAL]: https://www.github.com/ryukinix/mal
[MyAnimeList]: https://myanimelist.net/
More examples are covered on my personal blog post about [decorating](http://manoel.tk/decorating).
# Decorators & Usage
Currently public decorators on the API of decorators `decorating`:
* **decorating.debug**
* **decorating.cache**
* **decorating.counter**
* **decorating.count_time**
* **decorating.animated**
* **decorating.writing**
Mostly decorators has a pretty consistent usage, but for now only `animated`
and `writing` has support to use as `contextmanagers` using the `with` syntax.
# Installation
Supported Python versions:
* Python3.4+
* Python2.7
You can install the last release on [PyPI] by calling:
```shell
pip install --user decorating
```
If you want get the last development version install directly by the git
repository:
```shell
pip install --user git+https://www.github.com/ryukinix/decorating
```
We have a published package on [Arch Linux],which you can install
using your favorite AUR Helper, like `pacaur` or `yaourt`:
```shell
yaourt -S python-decorating
```
[Arch Linux]: https://aur.archlinux.org/packages/python-decorating/
[PyPI]: https://pypi.python.org/pypi/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]
which implemented the necessary changes to make compatible with Python2!
[Maxim Kuznetsov]: https://github.com/mkuznets
## License
[](https://pypi.python.org/pypi/decorating/)
[MIT](LICENSE)
Because good things need to be free.