{"id":22123139,"url":"https://github.com/markdouthwaite/minimal-flask-api","last_synced_at":"2025-10-09T01:36:54.887Z","repository":{"id":41878473,"uuid":"330212979","full_name":"markdouthwaite/minimal-flask-api","owner":"markdouthwaite","description":"A template for 'production ready' Flask APIs with Flask \u0026 Gunicorn. Includes template test and error-handling files.","archived":false,"fork":false,"pushed_at":"2022-02-02T14:40:44.000Z","size":20,"stargazers_count":103,"open_issues_count":0,"forks_count":38,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-10-04T14:04:27.681Z","etag":null,"topics":["flask","gunicorn","locust","pytest","python","python-api"],"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/markdouthwaite.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-16T17:04:46.000Z","updated_at":"2025-09-18T12:12:33.000Z","dependencies_parsed_at":"2022-08-26T23:11:10.927Z","dependency_job_id":null,"html_url":"https://github.com/markdouthwaite/minimal-flask-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/markdouthwaite/minimal-flask-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdouthwaite%2Fminimal-flask-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdouthwaite%2Fminimal-flask-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdouthwaite%2Fminimal-flask-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdouthwaite%2Fminimal-flask-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markdouthwaite","download_url":"https://codeload.github.com/markdouthwaite/minimal-flask-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdouthwaite%2Fminimal-flask-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000718,"owners_count":26082895,"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-10-08T02:00:06.501Z","response_time":56,"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":["flask","gunicorn","locust","pytest","python","python-api"],"created_at":"2024-12-01T15:29:30.468Z","updated_at":"2025-10-09T01:36:54.859Z","avatar_url":"https://github.com/markdouthwaite.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# minimal-flask-api\n\nThis [template repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template)\n provides a minimal configuration for a 'production-ready' Flask API \nproject. It includes a basic project structure and 'seed' files for functional and \nnon-function testing, a basic application structure (including error-handling \nblueprint), and a few assorted 'getting started' files too.\n\nThe template has been set up for use with Python \u003e= 3.7 and [Docker](https://www.docker.com/). \n\n## Running locally\n\nTo run the basic server, you'll need to install a few requirements. To do this, run:\n\n```bash\npip install -r requirements/common.txt\n```\n\nThis will install only the dependencies required to run the server. To boot up the \ndefault server, you can run:\n\n```bash\nbash bin/run.sh\n```\n\nThis will start a [Gunicorn](https://gunicorn.org/) server that wraps the Flask app \ndefined in `src/app.py`. Note that [this is one of the recommended ways of deploying a\nFlask app 'in production'](https://flask.palletsprojects.com/en/1.1.x/deploying/wsgi-standalone/). \nThe server shipped with Flask is [intended for development\npurposes only](https://flask.palletsprojects.com/en/1.1.x/deploying/#deployment).  \n\nYou should now be able to send:\n\n```bash\ncurl localhost:5000/health\n```\n\nAnd receive the response `OK` and status code `200`. \n\n## Running with `docker`\n\nUnsurprisingly, you'll need [Docker](https://www.docker.com/products/docker-desktop) \ninstalled to run this project with Docker. To build a containerised version of the API, \nrun:\n\n```bash\ndocker build . -t flask-app\n```\n\nTo launch the containerised app, run:\n\n```bash\ndocker run -p 5000:5000 flask-app\n```\n\nYou should see your server boot up, and should be accessible as before.\n\n## Developing with the template\n\nTo develop the template for your own project, you'll need to make sure to [create your\nown repository from this template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) \nand then install the project's development dependencies. You can do this with:\n\n```bash\npip install -r requirements/develop.txt\n```\n\nThis'll install some style formatting and testing tools (including `pytest` and \n`locust`).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkdouthwaite%2Fminimal-flask-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkdouthwaite%2Fminimal-flask-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkdouthwaite%2Fminimal-flask-api/lists"}