Generate dataframes from Cobli public API
Project description
cobli-libi
About the project
This package generates dataframes using Cobli's public API as data source.
It was created to enhance the experience of anyone who needs easy-to-use data from his/her Cobli fleet.
Data available in this package:
- Devices
- Checklists
- Proofs of conclusion
- Incidents
- Costs
- Vehicle performance
- Driver performance
Built with
Getting Started
Prerequisites
- Python 3.7 or higher
Installation
pip install cobli-libi
Usage
from datetime import datetime, timedelta
from libi.dataframes import get_devices_data, get_pocs_data, \
get_costs_data, get_incidents_data, get_checklist_data, \
get_driver_performance_data, get_vehicle_performance_data
fleet_data = {'Fleet Name': '<fleet_api_key>', 'Another Fleet': '<another_fleet_api_key'}
start_datetime = datetime.now() - timedelta(days=5)
end_datetime = datetime.now()
devices = get_devices_data(fleet_data)
checklists = get_checklist_data(fleet_data)
proofs_of_conclusion = get_pocs_data(fleet_data, start_datetime, end_datetime)
costs = get_costs_data(fleet_data, start_datetime, end_datetime)
incidents = get_incidents_data(fleet_data, start_datetime, end_datetime)
vehicle_performance = get_vehicle_performance_data(fleet_data, start_datetime, end_datetime)
driver_performance = get_driver_performance_data(fleet_data, start_datetime, end_datetime)
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Deploy
This project is in Pypi.
In order to deploy this project, the first action needed is bump the version in the file setup.py
.
After this, you will need to build the project with this command:
python3 -m build
Then, you will have to install twine with this command:
python3 -m pip install --upgrade twine
.
Finally, you can deploy in pypi using this command:
python3 -m twine upload dist/*
The credentials needed for this command are stored in 1Password by the key Admin-Pypi.
Contact
Project Link: https://github.com/cobliteam/cobli-libi
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cobli_libi-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd6786cbc3ae4bb1a5f79fa301fa6dbc9294ca1f1035e4f913f343556ed0cac3 |
|
MD5 | 7e450d5af7eeb212d192fbf9860e09db |
|
BLAKE2b-256 | a99cf4c0b851f625233bc496c7017fd2389accfc657eaf30217d4ff82db0afed |