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
Raw data
{
"_id": null,
"home_page": "https://github.com/thomann/plotAR",
"name": "plotar",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "plotar",
"author": "Philipp Thomann",
"author_email": "pht@gmx.ch",
"download_url": "https://files.pythonhosted.org/packages/e2/ef/7fdaf9b8ea9a3bca61eebbdc0b455a854ebd698335f90273eb46183be5ef/plotar-0.8.3.tar.gz",
"platform": "",
"description": "plotar\n=======\n\n# plotar - Walk Through your Data in Cardboard VR\n\nThis is a prototype to get your data into a Google Cardboard and navigate using the computer keyboard.\n\n> **Disclaimer:** This is in Alpha stage, lot of things can go wrong.\n> Data is transmitted in plain-text over you network and possibly further.\n>\n> Also the API is very instable.\n\n* Free software: Affero GPL 3\n\n\nInstallation\n------------\n\nPrerequisites:\n- Python 3 (we use Python 3.7)\n\nIt is recommended to use a virtual environment:\n```bash\npython -m venv venv\nsource venv/bin/activate\n```\nThe source statement has to be repeated whenever you open a new terminal.\n\nThen install this version\n```bash\npip install --upgrade git+https://github.com/thomann/plotar#egg=plotar&subdirectory=plotar-py\n```\n\nIf you want to use Jupyter, install it to the virtual environment:\n```bash\npip install jupyterlab\n```\n\n### Development\nTo install this module in Dev-mode, i.e. change files and reload module:\n```bash\ngit clone https://github.com/thomann/plotar\ncd plotar/plotar-py\n```\n\nIt is recommended to use a virtual environment:\n```bash\npython -m venv venv\nsource venv/bin/activate\n```\n\nInstall the version in edit mode:\n```bash\npip install -e .\n```\n\nIn Jupyter you can have reloaded code when you change the files as in:\n```python\n%load_ext autoreload\n%autoreload 2\n```\n\nUsage\n-----\n\n```python\nimport plotar\n\n# connect to running elastic or else start an Open Source stack on your docker\nfrom sklearn import datasets\niris = datasets.load_iris()\n\nplotar.plotar(iris.data, iris.target)\n```\n\nIn Jupyter you can open the controller:\n```python\nplotar.controller()\n```\n\nFeatures\n--------\n\n* Pandas based pipeline\n* Support for any extensions - now includes some for Regex, spaCy, VaderSentiment\n* Write results to ElasticSearch\n* Automatic Kibana dashboard generation\n* Have Elastic started in Docker if it is not installed locally or remotely\n* Apache License 2.0\n\nCredits\n-------\n\nThis package was created with [Cookiecutter](<https://github.com/audreyr/cookiecutter>) and the [`audreyr/cookiecutter-pypackage`]<https://github.com/audreyr/cookiecutter-pypackage> project template.\n\n\n=======\nHistory\n=======\n\n0.1.0 (2019-07-11)\n------------------\n\n* First Version\n\n\n",
"bugtrack_url": null,
"license": "Affero GPL 3",
"summary": "Walk through your data",
"version": "0.8.3",
"split_keywords": [
"plotar"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "ef3fc20df3da791b58a358eeff6e8748",
"sha256": "65cc09cd00bc5f12dd0c4925695127d3c75f84d4678e854d2ffa24b4e0ec751b"
},
"downloads": -1,
"filename": "plotar-0.8.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ef3fc20df3da791b58a358eeff6e8748",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 953209,
"upload_time": "2021-05-02T20:33:39",
"upload_time_iso_8601": "2021-05-02T20:33:39.920231Z",
"url": "https://files.pythonhosted.org/packages/e7/a7/fdc63763651039bcf8082cf06f789a09bdb6bfb68afc0e148d57f3b63a87/plotar-0.8.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "17d6f78fad5d28ecd4578222438bafa6",
"sha256": "63948592010e688763a4eaf8084ab870e641d95aa33e7b71f40c9cc84f5fd042"
},
"downloads": -1,
"filename": "plotar-0.8.3.tar.gz",
"has_sig": false,
"md5_digest": "17d6f78fad5d28ecd4578222438bafa6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 936966,
"upload_time": "2021-05-02T20:33:41",
"upload_time_iso_8601": "2021-05-02T20:33:41.448295Z",
"url": "https://files.pythonhosted.org/packages/e2/ef/7fdaf9b8ea9a3bca61eebbdc0b455a854ebd698335f90273eb46183be5ef/plotar-0.8.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-05-02 20:33:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "thomann",
"github_project": "plotAR",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "plotar"
}
JSON
