Welcome to the Carburoam repository, it fuels an Open Source dashboard to help users get cheapest prices at gas stations in 🇫🇷
Carburoam is an open-source built dashboard on top of Python, Streamlit and ❤️
It showcase a Data engineering project which :
- retrieve data daily from data.gouv.fr
- load it into a SQLite database
- Expose results to unlogged and logged users in live dashboard 👉 carburoam.streamlit.app
We run on a Streamlit backend, with an AWS S3 distant storage to persist data accross reboot of the Streamlit server.
A more complete overview of the stack is available in my blog post ⚙️ here
To manage local and distant environments, it uses an .ENV file, which shall contain theses keys :
- GMAIL_APP_PASSWORD : app password for streamlit gmail account
- LOAD_MODE="remote|local" : If remote, need AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
- BUCKET_NAME_STORE: Uri of the bucket where config file is stored, if using remote load mode
This repository uses somes github actions defined in .github/workflows folder.
It uses mock to setup a mocking environment and fire some pytest tests to ensure app is working properly.
Even though this project is not intended to be developed by the community, any suggestions or pull requests are happily welcomed.
We welcome security research on Carburoam under the terms of the following policy.
Under this policy, “research” means activities in which you:
- Notify us as soon as possible after you discover a real or potential security issue.
- Make every effort to avoid privacy violations, degradation of user experience, disruption to production systems, and destruction or manipulation of data.
- Only use exploits to the extent necessary to confirm a vulnerability’s presence. Do not use an exploit to compromise or exfiltrate data, establish persistent command line access, or use the exploit to pivot to other systems.
- Provide us a reasonable amount of time to resolve the issue before you disclose it publicly.
- Do not submit a high volume of low-quality reports.
Once you’ve established that a vulnerability exists or encounter any sensitive data (including personally identifiable information, financial information, or proprietary information or trade secrets of any party), you must stop your test, notify us immediately, and not disclose this data to anyone else.
The following test methods are not authorized:
- Network denial of service (DoS or DDoS) tests or other tests that impair access to or damage a system or data
- Physical testing (e.g. office access, open doors, tailgating), social engineering (e.g. phishing, vishing), or any other non-technical vulnerability testing
This policy applies to the following systems and services:
Please send an email (email address at the end paragraph of About blog page)
Thank you to the Streamlit community for the usage of their platform.
Thank you to Siddhant Sadangi for the streamlit sidebar template.
Thank you to Devoteam A Cloud for republishing my blog post on Rebirth blog
Have a look at License file
Happy Coding ❤️