{"repo":"openfoodfacts/folksonomy_api","free":true,"listed":false,"github":"https://github.com/openfoodfacts/folksonomy_api","clone":"git clone https://github.com/openfoodfacts/folksonomy_api.git","description":"A light REST API designed for Open Food Facts folksonomy engine","language":"Python","stars":26,"topics":["python","openfoodfacts","folksonomy-engine","openapi","swagger","fastapi","hacktoberfest"],"license":"AGPL-3.0","category":"api-integrations-sdks","readme_excerpt":"Folksonomy API A lightweight REST API designed for the Open Food Facts Folksonomy Engine. - Design documents : Folksonomy Engine Wiki - Production API endpoint : https://api.folksonomy.openfoodfacts.org/ - Pre-production API endpoint : https://api.folksonomy.openfoodfacts.net/ - Interactive API documentation : https://api.folksonomy.openfoodfacts.org/docs - Browser extension to try it live : folksonomy frontend GitHub - Note : Moderators can access the folksonomy engine directly on Open Food Facts without any extension. The UI has not yet been deployed on Open Products Facts, Open Pet Food Facts, or Open Beauty Facts, but it has been proven to work via the extension. Contributor's Guide Check out our Contributor's Guide. Feel free to improve it or ask questions! Dependencies - Language : Python 3.x - Framework : FastAPI - Database : PostgreSQL Development You should create unit tests for each new feature or API change (see test main.py). To run tests, simply launch: - The PYTHONASYNCIODEBUG=1 environment variable is important to ensure there are no pending asyncio tasks (a sign of potential issues). - Warning : Running tests will wipe the database. Do not run tests in production. Docker Setup Using Docker is the easiest way to get started with the Folksonomy API. It requires minimal setup and ensures a consistent development environment. Requirements - Docker 17.06.0+ - Docker Compose 1.21.0+ Quick Start 1. Clone the repository: 2. Copy the example settings file: 3. Create an","default_branch":null,"files":null,"tree":[],"storefront":"/r/openfoodfacts","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/openfoodfacts/folksonomy_api/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}