Metadata-Version: 2.1
Name: plotar
Version: 0.8.2
Summary: Walk through your data
Home-page: https://github.com/thomann/plotAR 
Author: Philipp Thomann
Author-email: pht@gmx.ch
License: Affero GPL 3
Keywords: plotar
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: requests
Requires-Dist: tornado
Requires-Dist: pyqrcode
Requires-Dist: click
Requires-Dist: usd-core

plotar
=======

# plotar - Walk Through your Data in Cardboard VR

This is a prototype to get your data into a Google Cardboard and navigate using the computer keyboard.

> **Disclaimer:** This is in Alpha stage, lot of things can go wrong.
> Data is transmitted in plain-text over you network and possibly further.
>
> Also the API is very instable.

* Free software: Affero GPL 3


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

Prerequisites:
- Python 3 (we use Python 3.7)

It is recommended to use a virtual environment:
```bash
python -m venv venv
source venv/bin/activate
```
The source statement has to be repeated whenever you open a new terminal.

Then install this version
```bash
pip install --upgrade git+https://github.com/thomann/plotar#egg=plotar&subdirectory=plotar-py
```

If you want to use Jupyter, install it to the virtual environment:
```bash
pip install jupyterlab
```

### Development
To install this module in Dev-mode, i.e. change files and reload module:
```bash
git clone https://github.com/thomann/plotar
cd plotar/plotar-py
```

It is recommended to use a virtual environment:
```bash
python -m venv venv
source venv/bin/activate
```

Install the version in edit mode:
```bash
pip install -e .
```

In Jupyter you can have reloaded code when you change the files as in:
```python
%load_ext autoreload
%autoreload 2
```

Usage
-----

```python
import plotar

# connect to running elastic or else start an Open Source stack on your docker
from sklearn import datasets
iris = datasets.load_iris()

plotar.plotar(iris.data, iris.target)
```

In Jupyter you can open the controller:
```python
plotar.controller()
```

Features
--------

* Pandas based pipeline
* Support for any extensions - now includes some for Regex, spaCy, VaderSentiment
* Write results to ElasticSearch
* Automatic Kibana dashboard generation
* Have Elastic started in Docker if it is not installed locally or remotely
* Apache License 2.0

Credits
-------

This package was created with [Cookiecutter](<https://github.com/audreyr/cookiecutter>) and the [`audreyr/cookiecutter-pypackage`]<https://github.com/audreyr/cookiecutter-pypackage> project template.


=======
History
=======

0.1.0 (2019-07-11)
------------------

* First Version


