{"id":15288258,"url":"https://github.com/firefly-cpp/succulent","last_synced_at":"2025-08-02T15:32:46.877Z","repository":{"id":167182086,"uuid":"629388250","full_name":"firefly-cpp/succulent","owner":"firefly-cpp","description":"Collect POST requests","archived":false,"fork":false,"pushed_at":"2025-07-31T12:27:47.000Z","size":477,"stargazers_count":3,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-31T15:27:13.931Z","etag":null,"topics":["data-collection","data-preprocessing-pipelines","data-science","esp32","machine-learning","raspberry-pi"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/firefly-cpp.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-04-18T08:02:34.000Z","updated_at":"2025-07-31T11:50:48.000Z","dependencies_parsed_at":"2023-11-09T13:27:42.801Z","dependency_job_id":"e99ca501-90f9-4c74-ae45-f053f21b8291","html_url":"https://github.com/firefly-cpp/succulent","commit_stats":null,"previous_names":["firefly-cpp/succulent"],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/firefly-cpp/succulent","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firefly-cpp%2Fsucculent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firefly-cpp%2Fsucculent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firefly-cpp%2Fsucculent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firefly-cpp%2Fsucculent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/firefly-cpp","download_url":"https://codeload.github.com/firefly-cpp/succulent/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firefly-cpp%2Fsucculent/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268082357,"owners_count":24192992,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data-collection","data-preprocessing-pipelines","data-science","esp32","machine-learning","raspberry-pi"],"created_at":"2024-09-30T15:44:56.019Z","updated_at":"2025-08-02T15:32:46.820Z","avatar_url":"https://github.com/firefly-cpp.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"logo\" width=\"300\" src=\".github/images/logo.png\"\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003e\nsucculent\n\u003c/h1\u003e\n\n\u003ch2 align=\"center\"\u003e\n  Collect POST requests easily\n\u003c/h2\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"PyPI Version\" src=\"https://img.shields.io/pypi/v/succulent.svg\"\u003e\n  \u003cimg alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/succulent.svg\"\u003e\n  \u003cimg alt=\"PyPI - Downloads\" src=\"https://img.shields.io/pypi/dm/succulent.svg\"\u003e\n  \u003ca href=\"https://aur.archlinux.org/packages/python-succulent\"\u003e\n    \u003cimg alt=\"AUR package\" src=\"https://img.shields.io/aur/version/python-succulent?color=blue\u0026label=Arch%20Linux\u0026logo=arch-linux\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://src.fedoraproject.org/rpms/python-succulent\"\u003e\n    \u003cimg alt=\"Fedora package\" src=\"https://img.shields.io/fedora/v/python3-succulent?color=blue\u0026label=Fedora%20Linux\u0026logo=fedora\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://pepy.tech/project/succulent\"\u003e\n    \u003cimg alt=\"Downloads\" src=\"https://static.pepy.tech/badge/succulent\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://repology.org/project/python:succulent/versions\"\u003e\n    \u003cimg alt=\"Packaging status\" src=\"https://repology.org/badge/tiny-repos/python:succulent.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/firefly-cpp/succulent/blob/master/LICENSE\"\u003e\n    \u003cimg alt=\"GitHub license\" src=\"https://img.shields.io/github/license/firefly-cpp/succulent.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/firefly-cpp/succulent/actions/workflows/test.yml\"\u003e\n    \u003cimg alt=\"Build\" src=\"https://github.com/firefly-cpp/succulent/actions/workflows/test.yml/badge.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://succulent.readthedocs.io/en/latest/?badge=latest\"\u003e\n    \u003cimg alt=\"Documentation status\" src=\"https://readthedocs.org/projects/succulent/badge/?version=latest\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"GitHub repo size\" src=\"https://img.shields.io/github/repo-size/firefly-cpp/succulent\"\u003e\n  \u003cimg alt=\"GitHub commit activity\" src=\"https://img.shields.io/github/commit-activity/w/firefly-cpp/succulent.svg\"\u003e\n  \u003ca href=\"http://isitmaintained.com/project/firefly-cpp/succulent\"\u003e\n    \u003cimg alt=\"Average time to resolve an issue\" src=\"http://isitmaintained.com/badge/resolution/firefly-cpp/succulent.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"http://isitmaintained.com/project/firefly-cpp/succulent\"\u003e\n    \u003cimg alt=\"Percentage of issues still open\" src=\"http://isitmaintained.com/badge/open/firefly-cpp/succulent.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"#-contributors\"\u003e\n    \u003cimg alt=\"All Contributors\" src=\"https://img.shields.io/badge/all_contributors-5-orange.svg\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://doi.org/10.5281/zenodo.10402365\"\u003e\n    \u003cimg alt=\"DOI\" src=\"https://zenodo.org/badge/DOI/10.5281/zenodo.10402365.svg\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#-detailed-insights\"\u003e🔍 Detailed Insights\u003c/a\u003e •\n  \u003ca href=\"#-installation\"\u003e📦 Installation\u003c/a\u003e •\n  \u003ca href=\"#-container\"\u003e🐳 Container\u003c/a\u003e •\n  \u003ca href=\"#-usage\"\u003e🚀 Usage\u003c/a\u003e •\n  \u003ca href=\"#-configuration\"\u003e🔧 Configuration\u003c/a\u003e •\n  \u003ca href=\"#-cite-us\"\u003e📄 Cite us\u003c/a\u003e •\n  \u003ca href=\"#-license\"\u003e🔑 License\u003c/a\u003e •\n  \u003ca href=\"#-contributors\"\u003e🫂 Contributors\u003c/a\u003e\n\u003c/p\u003e\n\nDo you ever find it challenging and tricky to send sensor measurements 📏, data 📊, or GPS positions from embedded devices 📱, microcontrollers, and [smartwatches](https://github.com/firefly-cpp/AST-Monitor) to a central server? 📡 Setting up the primary data collection scripts can be a time-consuming ⏳ process, involving selecting a protocol, framework, API, and testing them out. Moreover, these scripts are often tailored for specific tasks, making them difficult to adapt to different scenarios.\n\nBut fear not! Introducing succulent 🌵, a pure Python framework that simplifies the configuration, management, collection, and preprocessing of data collected via POST requests. This framework draws inspiration from real-world data collection challenges in [smart agriculture](https://github.com/firefly-cpp/smart-agriculture-datasets/tree/main/plant-monitoring-esp32) 🧠🌿, specifically plant monitoring using ESP32 devices. The main goal behind succulent is to streamline the process of configuring various data parameters and provide a range of useful functions for data transformations. By leveraging succulent, you can set up your entire data collection endpoint within minutes, freeing you from the hassle of dealing with server-side scripts. 🚀🔧\n\n* **Free software:** MIT license\n* **Documentation:** [https://succulent.readthedocs.io/en/latest](https://succulent.readthedocs.io/en/latest/)\n* **Python versions:** 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x\n* **Tested OS:** Windows, Ubuntu, Fedora, Alpine, Arch, macOS. **However, that does not mean it does not work on others**\n\n## 🔍 Detailed Insights\n\nThe current version of succulent comes packed with exciting features, including, but not limited to:\n\n- **Hassle-free generation of request URLs** for seamless data collection 🌐\n- **Effortless data retrieval** from POST requests 📥\n- **Versatile data storage options**, such as CSV, JSON, SQLite, XML, and even images 🗂️📊🖼️\n- **Customisable boundaries for collected data**, allowing you to set minimum and maximum thresholds ⚙️\n\nWith succulent, the process of collecting, managing, and preprocessing data becomes a breeze, empowering you to focus on what truly matters—gaining valuable insights from your embedded devices, microcontrollers, and smartwatches. ⌚ So why waste precious time? ⏳ Dive into the world of succulent and unlock the true potential of your data! 💪📈\n\n## 📦 Installation\n\n### pip\n\nTo install `succulent` with pip, use:\n\n```sh\npip install succulent\n```\n\n### Alpine Linux\n\nTo install `succulent` on Alpine Linux, use:\n\n```sh\n$ apk add py3-succulent\n```\n\n### Arch Linux\n\nTo install `succulent` on Arch Linux, use an [AUR helper](https://wiki.archlinux.org/title/AUR_helpers):\n\n```sh\n$ yay -Syyu python-succulent\n```\n\n### Fedora Linux\n\nTo install `succulent` on Fedora, use:\n\n```sh\n$ dnf install python3-succulent\n```\n\n## 🐳 Container\nCreate a `docker-compose.yml` file with the following content in the root directory:\n\n```yml\nversion: '3.8'\n\nservices:\n  app:\n    image: codeberg.org/firefly-cpp/succulent:v6\n    ports:\n      - \"8080:8080\"\n    volumes:\n      - ./run.py:/succulent-app/run.py\n      - ./configuration.yml:/succulent-app/configuration.yml\n    environment:\n      - GUNICORN_WORKERS=2\n```\n\nNext create a `configuration.yml` file in the root directory. Here's an example of a configuration file:\n\n```yml\ndata:\n  - name: 'temperature'\n  - name: 'humidity'\n  - name: 'light'\nresults:\n  - enable: true\n  - export: true\ntimestamp: true\n```\n\nMore information regarding the configuration file and its settings can be found in the [configuration](#-configuration) section.\n\nThen create a Python file named `run.py` with the following content in the root directory:\n\n```python\nfrom succulent.api import SucculentAPI\n\napi = SucculentAPI(config='configuration.yml', format='csv')\n\n# Flask app instance, called by gunicorn\napp = api.app\n```\n\nOnce you have set up the configuration file and the Python file, build the Docker image with the following command:\n\n```bash\ndocker compose build\n```\n\nFinally, run the Docker container with the following command:\n\n```bash\ndocker compose up\n```\n\n## 🚀 Usage\n\n### Example\n\n```python\nfrom succulent.api import SucculentAPI\napi = SucculentAPI(host='0.0.0.0', port=8080, config='configuration.yml', format='csv')\napi.start()\n```\n\n## 🔧 Configuration\n### Data collection\nIn the root directory, create a `configuration.yml` file and define the following:\n```yml\ndata:\n  - name: # Measure name\n    min:  # Minimum value (optional)\n    max:  # Maximum value (optional)\n```\n\nTo collect images, create a `configuration.yml` file in the root directory and define the following:\n```yml\ndata:\n  - key: # Key in POST request\n```\n\nTo store data collection timestamps, define the following setting in the `configuration.yml` file in the root directory:\n```yml\ntimestamp: true # false by default\n```\n\nTo access the URL for data collection, send a GET request (or navigate) to [http://localhost:8080/measure](http://localhost:8080/measure).\n\nTo restrict access to the collected data, define the following setting in the `configuration.yml` file in the root directory:\n```yml\npassword: 'password' # Password for data access\n```\n\nTo store data using a password, append the password parameter to the request URL: `?password=password`.\n\n### Data access\nTo access data via the Succulent API, define the following setting in the `configuration.yml` file in the root directory:\n```yml\nresults:\n  - enable: true # false by default\n```\n\nTo access the collected data, send a GET request (or navigate) to [http://localhost:8080/data](http://localhost:8080/data). To access password-protected data, append the password parameter to the request URL: `?password=password`.\n\n### Data export\nTo export the data, enable the export option in the configuration file:\n```yml\nresults:\n  - export: true # false by default\n```\n\nTo export the data, send a GET request (or navigate) to [http://localhost:8080/export](http://localhost:8080/export). To export password-protected data, append the password parameter to the request URL: `?password=password`. The data will be downloaded in the format specified in the configuration file.\n\n## 📄 Cite us\nFister Jr., Iztok, and Tadej Lahovnik. Succulent. 0.4.0, doi:[10.5281/zenodo.10402365](https://doi.org/10.5281/zenodo.10402365).\n\n## 🔑 License\n\nThis package is distributed under the MIT License. This license can be found online at \u003chttp://www.opensource.org/licenses/MIT\u003e.\n\n## Disclaimer\n\nThis framework is provided as-is, and there are no guarantees that it fits your purposes or that it is bug-free. Use it at your own risk!\n\n## 🫂 Contributors\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/lahovniktadej\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/57890734?v=4?s=100\" width=\"100px;\" alt=\"Tadej Lahovnik\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eTadej Lahovnik\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/firefly-cpp/succulent/commits?author=lahovniktadej\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/firefly-cpp/succulent/issues?q=author%3Alahovniktadej\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"#ideas-lahovniktadej\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"https://github.com/firefly-cpp/succulent/commits?author=lahovniktadej\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#tutorial-lahovniktadej\" title=\"Tutorials\"\u003e✅\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/AyanDas348\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/53610626?v=4?s=100\" width=\"100px;\" alt=\"Ayan Das\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eAyan Das\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/firefly-cpp/succulent/commits?author=AyanDas348\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/firefly-cpp/succulent/commits?author=AyanDas348\" title=\"Tests\"\u003e⚠️\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"http://www.iztok-jr-fister.eu/\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/1633361?v=4?s=100\" width=\"100px;\" alt=\"Iztok Fister Jr.\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eIztok Fister Jr.\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/firefly-cpp/succulent/commits?author=firefly-cpp\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#ideas-firefly-cpp\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"#mentoring-firefly-cpp\" title=\"Mentoring\"\u003e🧑‍🏫\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"http://carlosal1015.github.io\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/21283014?v=4?s=100\" width=\"100px;\" alt=\"Oromion\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eOromion\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/firefly-cpp/succulent/issues?q=author%3Acarlosal1015\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"#platform-carlosal1015\" title=\"Packaging/porting to new platform\"\u003e📦\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/rhododendrom\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/3198785?v=4?s=100\" width=\"100px;\" alt=\"rhododendrom\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003erhododendrom\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#design-rhododendrom\" title=\"Design\"\u003e🎨\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/zala-lahovnik\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/105444201?v=4?s=100\" width=\"100px;\" alt=\"Zala Lahovnik\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eZala Lahovnik\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/firefly-cpp/succulent/commits?author=zala-lahovnik\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffirefly-cpp%2Fsucculent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffirefly-cpp%2Fsucculent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffirefly-cpp%2Fsucculent/lists"}