{"id":17030041,"url":"https://github.com/alvarobartt/restx-cookie","last_synced_at":"2026-03-05T20:46:29.057Z","repository":{"id":118088169,"uuid":"246038052","full_name":"alvarobartt/restx-cookie","owner":"alvarobartt","description":":cookie: Flask RESTX API as a Python Package using @cookiecutter","archived":false,"fork":false,"pushed_at":"2020-07-23T12:13:09.000Z","size":52,"stargazers_count":9,"open_issues_count":4,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-12T12:11:49.331Z","etag":null,"topics":["cookiecutter","cookiecutter-flask","cookiecutter-python","cookiecutter-restx"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"wtfpl","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alvarobartt.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-03-09T13:07:39.000Z","updated_at":"2024-10-18T16:09:00.000Z","dependencies_parsed_at":null,"dependency_job_id":"fb9c6cf6-71d1-4179-a5dc-a92d3fd7c296","html_url":"https://github.com/alvarobartt/restx-cookie","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/alvarobartt/restx-cookie","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alvarobartt%2Frestx-cookie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alvarobartt%2Frestx-cookie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alvarobartt%2Frestx-cookie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alvarobartt%2Frestx-cookie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alvarobartt","download_url":"https://codeload.github.com/alvarobartt/restx-cookie/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alvarobartt%2Frestx-cookie/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266775383,"owners_count":23982273,"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-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":["cookiecutter","cookiecutter-flask","cookiecutter-python","cookiecutter-restx"],"created_at":"2024-10-14T08:03:38.499Z","updated_at":"2026-03-05T20:46:24.011Z","avatar_url":"https://github.com/alvarobartt.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eFlask-RESTX API as a Python Package Cookie\u003c/div\u003e\n\u003c/br\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://i.pinimg.com/originals/ac/a4/95/aca4951fa1d8d6da682821bc467ea6ce.png\" alt=\"cookie-monster\" height=\"300px\" hspace=\"20\"\u003e\n\u003c/div\u003e\n\n## Features\n\nThis cookie provides the following features:\n\n* A [Flask-RESTX](https://github.com/python-restx/flask-restx) API properly defined skeleton\n* An [argparse](https://docs.python.org/3/library/argparse.html) client which defines the entry point of the API\n* [Pytest](https://docs.pytest.org/en/latest/) unit tests\n* [Swagger.io](https://swagger.io/) automatic API reference documentation\n* and much more that will be progressively included...\n\n## Installation\n\nFirstly, you will need to install [cookiecutter](https://github.com/cookiecutter/cookiecutter) using pip from a Python3.6 version or higher since **this cookie recipe just works on Python3.6+**; use the following command:\n\n``pip install cookiecutter``\n\nSo as **to create your own cookie from this recipe you will need to clone this repository** using the following command:\n\n``git clone https://github.com/alvarobartt/restx-cookie``\n\nOnce it is properly cloned, from the working directory, you will need to **pass the cloned cookie as an argument to the cookiecutter entry point** as it follows:\n\n``cookiecutter /path/to/restx-cookie``\n\nThis command will launch the **cookiecutter prompt into your terminal**, which will ask you some configuration options as specified in the cookie recipe for you to select the most suitable ones according to your needs.\n\nSo to bake this cookie, the cookiecutter prompt will ask you to select the following ingredients (configuration) in case you want to name your cookie (project), for example, lets suppose that your project will be named `awesome_cookie` its configuration will be:\n\n```\nauthor [Alvaro Bartolome del Canto]: Cookie Monster\nemail [alvarobartt@example.com]: cookiemonster@sesamestreet.com\ngithub_username [alvarobartt]: cookie-monster       \nproject_name [Flask Restx API]: awesome-cookie\nproject_description [This project is a sample Python Flask Restx API]: This is an awesome cookie!   \nrepo_name [awesome_cookie]: awesome_cookie\npackage_name [awesome_cookie]: awesome_cookie\npypi_username [cookie-monster]: cookie-monster\nversion [1]: 1\nflask_limiter [yes]: yes\nflask_cache [yes]: yes\nflask_cors [yes]: yes\nSelect license:\n1 - MIT License\n2 - BSD License\n3 - ISC License\n4 - Apache Software License 2.0\n5 - GNU General Public License v3\n6 - WTFPL License\n7 - None\nChoose from 1, 2, 3, 4, 5, 6, 7 [1]: 1\n```\n\nWhen this process is finished, automatically a directory named as specified in `repo_name` will be created containing the following files and directories:\n\n``awesome_cookie/  MANIFEST.in  README.md  requirements.txt  setup.cfg  setup.py  tests/``\n\n**Congratulations! You already baked your own restx-cookie!**\n\n## Usage\n\n**Once the cookie is completely baked, you can take it off the oven!** So on, from the `repo_name` previously created directory, so as to **install the Flask RESTX API** (since it is a Python package) you will need to run on of the following commands: `pip install .` or `python setup.py install`, which will install not just the package but all its dependencies.\n\nOnce the newly created cookie is installed, just paste its **entry point** on the command line as it follows:\n\n`awesome_cookie`\n\n**The entry-point will launch the Flask RESTX API in your public IP (0.0.0.0) in the port 5000 using the current version** (which by deafult is the v1 version), so the complete address of the API is: `http://0.0.0.0:5000/v1`. In that address you will find the Swagger.io documentation automatically generated so as to know which endpoints are available, which data models are integrated, which is the input/output structure, etc.\n\n**Now you are completely free to eat your cookie!**\n\n## Cookie recipe created by...\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/alvarobartt\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/36760800?s=460\u0026v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr/\u003e\u003csub\u003e\u003cb\u003eÁlvaro Bartolomé\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr/\u003e\u003ca title=\"Code\"\u003e💻\u003c/a\u003e \u003ca title=\"Documentation\"\u003e📖\u003c/a\u003e\u003ca title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/gabrielmbmb\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/29572918?s=460\u0026v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr/\u003e\u003csub\u003e\u003cb\u003eGabriel Martín\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr/\u003e\u003ca title=\"Code\"\u003e💻\u003c/a\u003e\u003ca title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## Want more cookies?\n\nYou can find a curated collection of self made cookies at [cookie-jar](https://github.com/alvarobartt/cookie-jar)\n\n## You don't like this cookie? You don't like the chef/chefs?\n\nIf you don't like neither the cookie neither the chef (or chefs), to each his own... here we do not judge you (just a little), here you have a list of some **similar cookie recipes you may like**:\n\n- [cookiecutter-flask](https://github.com/cookiecutter-flask/cookiecutter-flask)\n- [cookiecutter-flask-skeleton](https://github.com/realpython/cookiecutter-flask-skeleton)\n- [flask-empty](https://github.com/italomaia/flask-empty)\n- [cookiecutter-flask-restful](https://github.com/karec/cookiecutter-flask-restful)\n\n## You want to become a chef too?\n\nMaybe after seeing this cookie recipe your inner chef spirit came out and you decided to become a chef, well, we already thought this may happen, so here you have a list of **useful links on your way to become a real chef** (well, not a real one just a programming chef somehow):\n\n- [cookiecutter](https://github.com/cookiecutter/cookiecutter)\n- [Getting to know Cookiecutter!](https://cookiecutter.readthedocs.io/en/1.7.0/tutorial1.html)\n- [Additional Tutorials](https://cookiecutter.readthedocs.io/en/latest/tutorials.html)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falvarobartt%2Frestx-cookie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falvarobartt%2Frestx-cookie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falvarobartt%2Frestx-cookie/lists"}