Skip to main content
[![Build Status](https://travis-ci.org/lightning-viz/lightning-python.svg?branch=master)](https://travis-ci.org/lightning-viz/lightning-python)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/lightning-viz/lightning?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)


Lightning python client
================

Python client for the [lightning](https://github.com/mathisonian/lightning) API

## installation
Install using:

```
pip install lightning-python
```
Compatible with Python 2.7 and 3.4.

## usage

### creating a session

```python
from lightning import Lightning

lgn = Lightning(host="http://my-lightning-instance.herokuapp.com")

lgn.create_session()
lgn.create_session("provide an optional session name")
```

### creating a visualization
Methods are available for the default visualization types included with Lightning
```python
lgn.line([1,2,3,4,5,6,7,8,0,-2,2])
lgn.scatter([1,2,3],[2,9,4])
```

### setting options
Visualizations can be customized through optional parameters
```python
lgn.scatter([1,2,3],[2,9,4], label=[1,2,3], size=[5,10,20])
```
### using custom plots
For custom plots not included with the default set, specify by name and provide data as a dictionary
```python
lgn.plot(data={"series": [1,2,3]}, type='line')
```

## examples

See a collection of [IPython notebooks](http://nbviewer.ipython.org/github/lightning-viz/lightning-example-notebooks/tree/master/).

## complete documentation

Available [here](http://lightning-viz.github.io/lightning-python/).

## running tests

Requires [pytest](http://pytest.org/latest/)

Clone the repo and install the library locally:

```sh
$ pip install -e .
```

The tests need to be run against a lightning server. By default they expect
this to be found at `http://localhost:3000`.

To run the tests:

```
$ py.test
```

or with against a custom host url


```
$ py.test --host=http://mylightninghost.herokuapp.com
```

## help

We maintain a [chatroom](https://gitter.im/lightning-viz/lightning) on gitter. If there's no response there: file an issue or reach out on twitter ([@mathisonian](http://twitter.com/matisonian), [@thefreemanlab](http://twitter.com/thefreemanlab))

Metadata

Release files for lightning-python 1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lightning-python 1.2.1
File Size Uploaded Provenance Actions
lightning-python-1.2.1.tar.gz 522.2 kB Without provenance Details for lightning-python-1.2.1.tar.gz

Release files / lightning-python-1.2.1.tar.gz

Download URL lightning-python-1.2.1.tar.gz
Size 522.2 kB
Tags Source
SHA-256 checksum
How to use checksums
3987d7d4a634bdb6db9bcf212cf4d2f72bab5bc039f4f6cbc02c9d01c4ade792
BLAKE2b-256 checksum
How to use checksums
9cae36f6dc88f0f8fcd59de9e2ebe517923229de05f7b437b6efd11b58c50f42
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for lightning-python 1.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page