This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
animation
===============================

Tools for terminal-based wait animations


Installation
------------

```bash
git clone http://github.com/bprinty/animation.git
cd animation
python setup.py install
```


Usage
-----

The animation module provides decorators for doing terminal-based wait animations. To add a wait animation to a function that requires some processing time, simply decorate the function with the wait animation you want to use.

Here is an example of how to use it in a project:

```python
import animation
import time

@animation.simple_wait
def long_running_function():
... 5 seconds later ...
return
```

This will print an animated waiting message like this (the elipses at the end of the text grow and shrink while the function executes):

```bash
waiting ...
```

The animation types provided by default are:

* bar (simple bar that slides back and forth)
* spinner (a spinning line)
* dots (dots that move around in a sqare)
* elipses (elipses that grow and shrink)
* text with elipses (elipses with text in front of them)


And you can use any of these built-in animations like so:

```python
import animation
import time

@animation.wait('bar')
def long_running_function():
... 5 seconds later ...
return

@animation.wait('spinner')
def long_running_function():
... 5 seconds later ...
return
```

In addition to these default types, the module also supports custom animations. For example, to create an animation with a counter-clockwise spinning wheel:

```python
wheel = ('-', '/', '|', '\\')
@animation.wait(wheel)
def long_running_function():
... 5 seconds later ...
return
```

If you want to manually start and stop the wait animation, you can use the ```animation.Wait``` class:

```python
wait = animation.Wait()
wait.start()
long_running_function()
wait.stop()
```


Questions/Feedback
------------------

File an issue in the [GitHub issue tracker](https://github.com/bprinty/animation/issues)
Release History

Release History

0.0.1

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
animation-0.0.1.tar.gz (8.7 kB) Copy SHA256 Checksum SHA256 Source Apr 15, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting