معرفی شرکت ها
ecobici-0.0.3
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
This is a python wrapper for the ecobici api
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | ecobici-0.0.3 |
| نام | ecobici |
| نسخه کتابخانه | 0.0.3 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Marco Nila |
| ایمیل نویسنده | contact.marconila@gmail.com |
| آدرس صفحه اصلی | https://github.com/sainoba/ecobici_py |
| آدرس اینترنتی | https://pypi.org/project/ecobici/ |
| مجوز | - |
# Ecobici python wrapper
[](https://travis-ci.com/sainoba/ecobici_py)
[](https://badge.fury.io/py/ecobici)
## Installation
`pip install ecobici`
## Usage
```python
# Import module
from ecobici import Ecobici
# Initialize client
client = Ecobici(your_client_id, your_client_secret)
# Get dictionary containing stations
stations = client.get_stations()
# Get dictionary containing the status of stations
stations_status = client.get_stations_status()
# (Optional) Force refresh token
client.refresh_token()
```
### Examples
#### Get the name of the first station
```python
from ecobici import Ecobici
client = Ecobici(your_client_id, your_client_secret)
list_of_stations = client.get_stations()["stations"]
print("The name of the first station is ", list_of_stations[0]["name"])
```
[Check the Data structure section for more information](#data-structure)
#### Get the status of the third station
```python
from ecobici import Ecobici
client = Ecobici(your_client_id, your_client_secret)
list_of_stations = client.get_stations_status()["stationsStatus"]
print("The status of the third station is ", list_of_stations[3]["status"])
```
[Check the Data structure section for more information](#data-structure)
## Data structure
### Stations structure
This module translate the json objects to python objects and returns it to the user,
it doesn't unwraps it because I didn't want to modify the data.
The econduce's API returns data in the following json format,
that's why you have to manually unwrap it with `client.get_stations_status()["stations"]`:
```json5
{
"stations": [
{
"id": 448,
"name": "448 DR. ANDRADE - ARCOS DE BELÉN",
"address": "DR. ANDRADE ARCOS DE BELÉN",
"addressNumber": "S/N",
"zipCode": null,
"districtCode": null,
"districtName": null,
"altitude": null,
"nearbyStations": [
448
],
"location": {
"lat": 19.426611,
"lon": -99.14447
},
"stationType": "BIKE,TPV"
},
]
}
```
#### Structure and types
|Key|Type|
|---|---|
|id|int|
|name|str|
|address|str|
|addressNumber|str|
|zipCode|str|
|districtCode|str|
|districtName|str|
|nearbyStations|list with id (int)|
|location|list|
|stationType|str|
Location list:
|Key|Type|
|---|---|
|lat|float|
|lon|float|
Latitud and logitud are coordinates based on the [World Geodetic System (WGS84)](https://es.wikipedia.org/wiki/WGS84).
### Status structure
This module translate the json objects to python objects and returns it to the user,
it doesn't unwraps it because I didn't want to modify the data.
The econduce's API returns data in the following json format,
that's why you have to manually unwrap it with `client.get_stations_status()["stationsStatus"]`:
```json5
{
"stationsStatus": [
{
"id": 1,
"status": "OPN",
"availability": {
"bikes": 4,
"slots": 23
}
},
]
}
```
#### Structure and types
|Key|Type|
|---|---|
|id|int|
|status|str (OPN means open, CLS means closed)|
|availability|list|
Availability list:
|Key|Type|
|---|---|
|bikes|int|
|slots|int|
## Test
`python3 -m pytest ecobici/test.py`
## Notes
- There's no need to refresh the token when it expires. The client does it automatically.
- Ecobici's API can return _null_ values. It's up to you to verify that the value you want to access if defined.
- You can find more information about the API structure here: [Spanish documentation](https://www.ecobici.cdmx.gob.mx/sites/default/files/pdf/manual_api_opendata_esp_final.pdf).
نحوه نصب
نصب پکیج whl ecobici-0.0.3:
pip install ecobici-0.0.3.whl
نصب پکیج tar.gz ecobici-0.0.3:
pip install ecobici-0.0.3.tar.gz