# LSPAPI
Eine simple API um Daten aus [Leitstellenspiel](https://www.leitstellenspiel.de/) zu erhalten.
## Basic usage
```python
from pyLSPAPI import LSPAPI
user = "" # LSP username
password = "" # LSP password
key_file = "keyfile.key" # The file where cookies are saved (for fater second login)
key_file_password = "supersecretpassword" # encryption password for keyfile
lsp_api = LSPAPI(user, password, key_file, key_file_password)
lsp_api.start()
try:
# All functions
print(lsp_api.vehicle_states())
print(lsp_api.user_stats())
print(lsp_api.vehicles())
print(lsp_api.buildings())
finally:
lsp_api.stop()
```
## Installation
Using pip:
`pip install pyLSPAPI`
## List of Functions
### vehicle_states()
Returns how many vehicles are in what state.
---
### user_stats()
Returns information about the player.
---
### vehicles()
Returns the vehicles of the player.
---
### buildings()
Returns the buildings of the player.
> [!IMPORTANT]
> # DISCLAIMER
> I (the creator of this software) am NOT responsible for any damages done by this program.
> [!TIP]
> If you are an Administrator of Leitstellenspiel and want this repo removed, please submit an issue containing the reason and a link to a Leitstellenspiel Forum post to verify that you are an Administrator. After that The repo will be taken down :)
Raw data
{
"_id": null,
"home_page": "https://github.com/Leo-Aqua/LSPAPI",
"name": "pyLSPAPI",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Leitstellenspiel, API, LSPAPI, LSS, API",
"author": "Leo Aqua",
"author_email": "contact@leoaqua.de",
"download_url": "https://files.pythonhosted.org/packages/45/aa/01fc77dc3424d1031d5d0c356ca6ce04dad508851b7453b3b7a04c5bb68b/pylspapi-1.0.4.tar.gz",
"platform": null,
"description": "# LSPAPI\r\nEine simple API um Daten aus [Leitstellenspiel](https://www.leitstellenspiel.de/) zu erhalten.\r\n\r\n## Basic usage\r\n```python\r\nfrom pyLSPAPI import LSPAPI\r\n\r\nuser = \"\" # LSP username\r\npassword = \"\" # LSP password\r\n\r\nkey_file = \"keyfile.key\" # The file where cookies are saved (for fater second login)\r\nkey_file_password = \"supersecretpassword\" # encryption password for keyfile\r\n\r\nlsp_api = LSPAPI(user, password, key_file, key_file_password)\r\nlsp_api.start()\r\ntry:\r\n # All functions\r\n print(lsp_api.vehicle_states())\r\n print(lsp_api.user_stats())\r\n print(lsp_api.vehicles())\r\n print(lsp_api.buildings())\r\n\r\nfinally:\r\n lsp_api.stop()\r\n\r\n```\r\n\r\n## Installation\r\n\r\nUsing pip:\r\n`pip install pyLSPAPI`\r\n\r\n\r\n## List of Functions\r\n\r\n### vehicle_states()\r\nReturns how many vehicles are in what state.\r\n\r\n---\r\n### user_stats()\r\nReturns information about the player.\r\n\r\n---\r\n### vehicles()\r\nReturns the vehicles of the player.\r\n\r\n---\r\n### buildings()\r\nReturns the buildings of the player.\r\n\r\n\r\n\r\n> [!IMPORTANT]\r\n> # DISCLAIMER\r\n> I (the creator of this software) am NOT responsible for any damages done by this program. \r\n\r\n\r\n> [!TIP]\r\n> If you are an Administrator of Leitstellenspiel and want this repo removed, please submit an issue containing the reason and a link to a Leitstellenspiel Forum post to verify that you are an Administrator. After that The repo will be taken down :)\r\n\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Python API for Leitstellenspiel",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/Leo-Aqua/LSPAPI"
},
"split_keywords": [
"leitstellenspiel",
" api",
" lspapi",
" lss",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "edd123fabc53f5367245bf1b5853d3f7cd00bf78a93e4d1a3b121c748fb55852",
"md5": "dc00af437d9bc1f1c450b916397b43c3",
"sha256": "c2df354e1152ae98c0037b046565cfa430c613ee9f05b1b681a7592821faf665"
},
"downloads": -1,
"filename": "pyLSPAPI-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc00af437d9bc1f1c450b916397b43c3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4256,
"upload_time": "2024-06-19T19:43:50",
"upload_time_iso_8601": "2024-06-19T19:43:50.969414Z",
"url": "https://files.pythonhosted.org/packages/ed/d1/23fabc53f5367245bf1b5853d3f7cd00bf78a93e4d1a3b121c748fb55852/pyLSPAPI-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "45aa01fc77dc3424d1031d5d0c356ca6ce04dad508851b7453b3b7a04c5bb68b",
"md5": "dd26bb4525ca09a804cd244dafd4b106",
"sha256": "d38d4f95543fe7a6342c1514abad920c6f89879d53a499d99ee90993de6e0d1f"
},
"downloads": -1,
"filename": "pylspapi-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "dd26bb4525ca09a804cd244dafd4b106",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4241,
"upload_time": "2024-06-19T19:43:52",
"upload_time_iso_8601": "2024-06-19T19:43:52.741344Z",
"url": "https://files.pythonhosted.org/packages/45/aa/01fc77dc3424d1031d5d0c356ca6ce04dad508851b7453b3b7a04c5bb68b/pylspapi-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-19 19:43:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Leo-Aqua",
"github_project": "LSPAPI",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pylspapi"
}
JSON
