<div align="center">
<a href="https://satplat.com/" target="_blank"> <img src="https://user-images.githubusercontent.com/29748439/211309040-f338a8c8-2617-455d-bcae-0727eceb622a.png" width=300 /> </a>
</div>
<h1 align="center">Python SatPlat Api Client</h1>
<h3 align="center">a simple module to integrate with SatPlat satellite image api service</h3>
# Overview
- [Overview](#overview)
- [Installation](#installation)
- [Usage](#usage)
- [References](#references)
- [Swagger](#swagger)
# Installation
This module is a pip package to let you integrate with satplat api service provider. in order to use this module you have to install it by pip command or through setup.
```bash
pip install satplat_api
```
Import package into your project by:
```bash
from satplat_api.api import SatPlatAPI
```
in order to use the module please consider looking at examples and documentations.
# Usage
In order to integrate with this service provider you need to first have an account and token. so first of all create an account with the url provided below:
<https://dashboard.satplat.com/#/login>
For easy implementations i have provided two simple examples, one for creating authenticating and getting access key and one for simple example to get current data from a location
```python
# importing satplat module
from satplat_api.api import SatPlatAPI
# creating an instance client
client = SatPlatAPI()
# setting up access token
client.set_access_token(access_token="<YOUR_TOKEN>")
```
now that you have access token with unlimited time access then there is no need for authenticating, you can just set the access_token and proceed with other requests.
```python
#importing satplat module
from satplat_api.api import SatPlatAPI
# creating an instance client
client = SatPlatAPI()
# setting the access token for headers in client object
client.set_access_token(access_token="<YOUR_TOKEN>")
# to get farms list
pprint(client.get_farms_list())
```
# References
- <a href="./docs/satplat-api-document.pdf">document</a>
# Swagger
i even did create a custom swagger for testing purposes
<div align="center">
<img src="https://user-images.githubusercontent.com/29748439/211308445-95044159-842d-4e13-ba1d-a345e84785da.png"/>
</div>
Raw data
{
"_id": null,
"home_page": "https://github.com/AliBigdeli/Python-SatPlat-Client",
"name": "satplat-api",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "satplat,api,sattelite api,image,process",
"author": "Ali Bigdeli",
"author_email": "bigdeli.ali3@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/56/19/f4d00780d3b37ac01455ee1397599db3b3859cf56b7a4e8ed6f76d389909/satplat_api-0.1.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\r\n\r\n<a href=\"https://satplat.com/\" target=\"_blank\"> <img src=\"https://user-images.githubusercontent.com/29748439/211309040-f338a8c8-2617-455d-bcae-0727eceb622a.png\" width=300 /> </a>\r\n\r\n</div>\r\n\r\n<h1 align=\"center\">Python SatPlat Api Client</h1>\r\n<h3 align=\"center\">a simple module to integrate with SatPlat satellite image api service</h3>\r\n\r\n# Overview\r\n- [Overview](#overview)\r\n- [Installation](#installation)\r\n- [Usage](#usage)\r\n- [References](#references)\r\n- [Swagger](#swagger)\r\n\r\n# Installation\r\nThis module is a pip package to let you integrate with satplat api service provider. in order to use this module you have to install it by pip command or through setup.\r\n\r\n```bash\r\npip install satplat_api\r\n```\r\nImport package into your project by:\r\n\r\n```bash\r\nfrom satplat_api.api import SatPlatAPI\r\n```\r\nin order to use the module please consider looking at examples and documentations.\r\n\r\n# Usage\r\nIn order to integrate with this service provider you need to first have an account and token. so first of all create an account with the url provided below:\r\n<https://dashboard.satplat.com/#/login>\r\n\r\n\r\nFor easy implementations i have provided two simple examples, one for creating authenticating and getting access key and one for simple example to get current data from a location\r\n\r\n```python\r\n# importing satplat module\r\nfrom satplat_api.api import SatPlatAPI\r\n\r\n# creating an instance client\r\nclient = SatPlatAPI()\r\n\r\n# setting up access token\r\nclient.set_access_token(access_token=\"<YOUR_TOKEN>\")\r\n\r\n```\r\n\r\nnow that you have access token with unlimited time access then there is no need for authenticating, you can just set the access_token and proceed with other requests.\r\n\r\n\r\n```python\r\n#importing satplat module\r\nfrom satplat_api.api import SatPlatAPI\r\n\r\n# creating an instance client\r\nclient = SatPlatAPI()\r\n\r\n# setting the access token for headers in client object\r\nclient.set_access_token(access_token=\"<YOUR_TOKEN>\")\r\n\r\n# to get farms list \r\npprint(client.get_farms_list())\r\n\r\n```\r\n\r\n# References\r\n\r\n- <a href=\"./docs/satplat-api-document.pdf\">document</a>\r\n\r\n\r\n# Swagger\r\ni even did create a custom swagger for testing purposes\r\n\r\n<div align=\"center\">\r\n<img src=\"https://user-images.githubusercontent.com/29748439/211308445-95044159-842d-4e13-ba1d-a345e84785da.png\"/>\r\n</div>\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "a package to integrate satplat api with python client",
"version": "0.1.1",
"split_keywords": [
"satplat",
"api",
"sattelite api",
"image",
"process"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f5428213020875bdb2aab8b98b7765054201a33be6e9cfc2235f4cf53053f87e",
"md5": "7be6c5968218a61fd4988f847bf76805",
"sha256": "bbc2a14dd44b7c12b54d16bb41514301b4cdec70ca566639a595d54bd815319c"
},
"downloads": -1,
"filename": "satplat_api-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7be6c5968218a61fd4988f847bf76805",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3624,
"upload_time": "2023-01-09T12:37:19",
"upload_time_iso_8601": "2023-01-09T12:37:19.044187Z",
"url": "https://files.pythonhosted.org/packages/f5/42/8213020875bdb2aab8b98b7765054201a33be6e9cfc2235f4cf53053f87e/satplat_api-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5619f4d00780d3b37ac01455ee1397599db3b3859cf56b7a4e8ed6f76d389909",
"md5": "ff0b554291fb42b60fca06046d42aa9f",
"sha256": "4dc19da0e0e4fdf806a22b7ba82458679c0bb2c4a3d113f2ba4b7e553c4d6257"
},
"downloads": -1,
"filename": "satplat_api-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "ff0b554291fb42b60fca06046d42aa9f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3427,
"upload_time": "2023-01-09T12:37:21",
"upload_time_iso_8601": "2023-01-09T12:37:21.001840Z",
"url": "https://files.pythonhosted.org/packages/56/19/f4d00780d3b37ac01455ee1397599db3b3859cf56b7a4e8ed6f76d389909/satplat_api-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-09 12:37:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "AliBigdeli",
"github_project": "Python-SatPlat-Client",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "satplat-api"
}
JSON
