Metadata-Version: 2.1
Name: spartaqube
Version: 0.1.17
Summary: SpartaQube is a plug and play solution to visualize your data and build web components
Home-page: https://spartaqube.com
Author: Spartacus
Author-email: spartaqube@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: aerospike
Requires-Dist: arctic
Requires-Dist: arcticdb
Requires-Dist: cassandra-driver
Requires-Dist: channels==3.0.4
Requires-Dist: clickhouse_connect
Requires-Dist: cloudpickle
Requires-Dist: couchdb
Requires-Dist: cx_Oracle
Requires-Dist: django<5.0,>=4.0
Requires-Dist: django-async
Requires-Dist: django-async-orm
Requires-Dist: django-channels
Requires-Dist: django-cors-headers
Requires-Dist: django_debug_toolbar
Requires-Dist: django-picklefield
Requires-Dist: django-prometheus
Requires-Dist: djangorestframework
Requires-Dist: duckdb
Requires-Dist: influxdb_client
Requires-Dist: ipython==8.17.2
Requires-Dist: ipykernel==6.29.4
Requires-Dist: jupyter_client
Requires-Dist: jupyter_core
Requires-Dist: jupyterlab
Requires-Dist: mysql-connector-python
Requires-Dist: numpy
Requires-Dist: openpyxl
Requires-Dist: pandas
Requires-Dist: Pillow
Requires-Dist: psycopg2-binary
Requires-Dist: pymongo==3.11.0
Requires-Dist: pymssql
Requires-Dist: PyMySQL
Requires-Dist: pyodbc
Requires-Dist: python-dateutil
Requires-Dist: pytz
Requires-Dist: quantstats
Requires-Dist: questdb
Requires-Dist: redis
Requires-Dist: requests
Requires-Dist: requests-oauthlib
Requires-Dist: SQLAlchemy
Requires-Dist: tinykernel
Requires-Dist: tqdm
Requires-Dist: typer
Requires-Dist: whitenoise

# <img src="https://www.spartaquant.com/assets/img/spartaquant/icon-color.png" width="60px" alt="SpartaQube icon" class="logo-default"> SpartaQube

[SpartaQube](https://www.spartaqube.com) is a plug and play solution to visualize your data and build web components

Use SpartaQube to
1. Access your data through already built-in connectors
2. Apply transformations to your data using the SpartaQube notebook
3. Create charts and web components by dragging & dropping your transformed data

The rich user interface makes it easy to visualize and retrieve all your components

You can expose and share them with a simple html snippet code

## Installation

#### PIP INSTALL

Install the package via pip with code below:

```python
pip install spartaqube
```

To Upgrade:


```python
pip install --upgrade spartaqube
```

#### DOCKER INSTALL

Install the application via docker with the code below:

```python
docker run -p 8664:8000 spartaquant/spartaqube
```

You can change the listening port 8664 to any available port you want

Then the application runs locally and is accessible in your browser at http://localhost:8664

Get more information regarding the docker application at:
https://hub.docker.com/r/spartaqube/spartaqube


## Jupyter Notebook Integration

SpartaQube can be embedded within your usual Jupyter notebooks

Interact with your data with drag & drop and build your web components in few clicks

1. Import library
```python
from api.spartaqube import Spartaqube as Spartaqube
spartaqube_obj = Spartaqube()
```

Get your app token and run the API with a registered account:
```python
from api.spartaqube import Spartaqube as Spartaqube
spartaqube_obj = Spartaqube(app_token)
```

2. List available components
```python
spartaqube_obj.get_library()
```

3. Get a specific SpartaQube widget
```python
spartaqube_obj.get_widget("<widget_id>")
```

4. Create a new component using the interactive plot editor
```python
spartaqube_obj.iplot(variable1, variable2, ...)
```

Check out the documentation of the API at https://spartaqube.com/api for more information

