# Lightspark Python SDK
The Lightspark Python SDK provides a convenient way to interact with the Lightspark services from applications written in the Python language.
## Installation
To install the SDK, simply run:
```bash
pip install lightspark
```
## Documentation
The documentation for this SDK (installation, usage, etc.) is available at https://docs.lightspark.com/lightspark-sdk/getting-started?language=Python
## Sample code
For your convenience, we included an example that shows you how to use the SDK.
Open the file `example.py` and make sure to update the variables at the top of the page with your information, then run it using pipenv:
```python
pipenv install
pipenv run python -m examples.example
```
There are also a few examples of webservers for demonstrating webhooks and LNURLs. These can similarly be run through Flask:
```python
pipenv install -d
pipenv run flask --app examples.flask_lnurl_server run
```
Note that Flask requires Python >= 3.8, so these examples will not work if running Python 3.7.
Raw data
{
"_id": null,
"home_page": "https://www.lightspark.com/",
"name": "lightspark",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Lightspark Group, Inc.",
"author_email": "info@lightspark.com",
"download_url": "https://files.pythonhosted.org/packages/ea/65/655210b2713555490e1e5860a7fa006dce17ba801810e4e78d6c13df1343/lightspark-2.10.1.zip",
"platform": null,
"description": "# Lightspark Python SDK\n\nThe Lightspark Python SDK provides a convenient way to interact with the Lightspark services from applications written in the Python language.\n\n## Installation\n\nTo install the SDK, simply run:\n\n```bash\npip install lightspark\n```\n\n## Documentation\n\nThe documentation for this SDK (installation, usage, etc.) is available at https://docs.lightspark.com/lightspark-sdk/getting-started?language=Python\n\n## Sample code\n\nFor your convenience, we included an example that shows you how to use the SDK.\nOpen the file `example.py` and make sure to update the variables at the top of the page with your information, then run it using pipenv:\n\n```python\npipenv install\npipenv run python -m examples.example\n```\n\nThere are also a few examples of webservers for demonstrating webhooks and LNURLs. These can similarly be run through Flask:\n\n```python\npipenv install -d\npipenv run flask --app examples.flask_lnurl_server run\n```\n\nNote that Flask requires Python >= 3.8, so these examples will not work if running Python 3.7.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python SDK for the Lightspark API",
"version": "2.10.1",
"project_urls": {
"Documentation": "https://docs.lightspark.com/lightspark-sdk/getting-started?language=Python",
"Homepage": "https://www.lightspark.com/",
"Source Code": "https://github.com/lightsparkdev/python-sdk"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ea65655210b2713555490e1e5860a7fa006dce17ba801810e4e78d6c13df1343",
"md5": "c3cfe87a925af780561e337363b2b77b",
"sha256": "32c63cee2af08677c7fa2eefbb86ecfcd654a75cd33765f5e13fd312a1a01225"
},
"downloads": -1,
"filename": "lightspark-2.10.1.zip",
"has_sig": false,
"md5_digest": "c3cfe87a925af780561e337363b2b77b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 232149,
"upload_time": "2024-07-22T19:10:07",
"upload_time_iso_8601": "2024-07-22T19:10:07.237583Z",
"url": "https://files.pythonhosted.org/packages/ea/65/655210b2713555490e1e5860a7fa006dce17ba801810e4e78d6c13df1343/lightspark-2.10.1.zip",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-22 19:10:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lightsparkdev",
"github_project": "python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lightspark"
}
JSON
