Metadata-Version: 2.1
Name: cinestats
Version: 0.0.2
Summary: Analyse and visualise statistics around movies and cinema.
Home-page: https://github.com/lkluft/cinestats
Author: Lukas Kluft
Author-email: lukas.kluft@gmail.com
License: GPL-3.0
Platform: UNKNOWN
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: matplotlib
Requires-Dist: numpy
Provides-Extra: tests
Requires-Dist: flake8 ; extra == 'tests'
Requires-Dist: pytest ; extra == 'tests'

# cinestats ![Test](https://github.com/lkluft/cinestats/workflows/Test/badge.svg)
Analyse and visualise statistics around movies and cinema.

## Installation and requirements
Cinestats requires Python version 3.5 or higher.
You can install the cloned working copy using ``pip``:
```bash
$ git clone https://github.com/atmtools/typhon.git
$ pip install cinestats
```

## Testing
Tests can be run on the command line using [pytest]:
```bash
$ pytest --pyargs cinestats
```

## Usage
Cinestats is build around the `MovieDatabase` class. It combines all
functionality to work on sets of movies.
```python
import matplotlib.pyplot as plt
from cinestats import MovieDatabase


mdb = MovieDatabase.from_csv('cinestats/data/example.csv')

fig, ax = plt.subplots()
mdb.plot_marker()
plt.show()
```

### CSV data format
Movie databases can be stored as CSV file. Currently, the two fields `date` and
`movie` are supported:
```
date,movie
2017-01-01,Shaun of the Dead
2017-01-03,World's End
2017-01-02,Hot Fuzz
```

[Anaconda]: https://www.continuum.io/downloads
[pytest]: https://docs.pytest.org/en/latest/


