{"id":37734283,"url":"https://github.com/yeuk0/pybuilder-archetype-api","last_synced_at":"2026-01-16T13:56:18.218Z","repository":{"id":62579101,"uuid":"249501169","full_name":"yeuk0/pybuilder-archetype-api","owner":"yeuk0","description":"External plugin for PyBuilder to generate a web service project structure","archived":false,"fork":false,"pushed_at":"2023-05-01T21:22:01.000Z","size":18,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-31T18:09:10.585Z","etag":null,"topics":["api-rest","archetype","flask-api","gunicorn-with-flask-rest-api","plugin","pybuilder","pybuilder-plugin","python","template"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yeuk0.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":"2020-03-23T17:39:28.000Z","updated_at":"2020-05-07T11:02:30.000Z","dependencies_parsed_at":"2023-01-21T18:03:22.103Z","dependency_job_id":null,"html_url":"https://github.com/yeuk0/pybuilder-archetype-api","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/yeuk0/pybuilder-archetype-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yeuk0%2Fpybuilder-archetype-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yeuk0%2Fpybuilder-archetype-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yeuk0%2Fpybuilder-archetype-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yeuk0%2Fpybuilder-archetype-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yeuk0","download_url":"https://codeload.github.com/yeuk0/pybuilder-archetype-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yeuk0%2Fpybuilder-archetype-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28479039,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["api-rest","archetype","flask-api","gunicorn-with-flask-rest-api","plugin","pybuilder","pybuilder-plugin","python","template"],"created_at":"2026-01-16T13:56:17.542Z","updated_at":"2026-01-16T13:56:18.212Z","avatar_url":"https://github.com/yeuk0.png","language":"Python","readme":"# PyBuilder Archetype API Plugin\n\nThis plugin generates a structure for a project that requieres endpoints (APIs or web services). This plugin needs\n[pybuilder_archetype_base](https://github.com/yeuk0/pybuilder-archetype-base) due to its dependancy with one of its\ntasks (`create_archetype_api`).\n\nIn the following diagram there is every directory and file created during `create_archetype_api` execution (take note\n that `create_archetype_base` task will add more packages and directories -check its `README.md` file for more\n information):\n\n```text\nsrc\n└── package_name\n    ├── api  # For every script related with the web services\n    |   ├── __init__.py\n    |   └── api_example.py\n    ├── config\n    |   ├── __init__.py\n    |   └── constants.py\n    ├── __init__.py\n    ├── gunicorn_config.py  # Gunicorn launching configuration\n    ├── main.py  # Script with Flask app\n    └── wsgi.py  # WSGI file for server launch\nrequirements.txt\n```\n\nContent from `requirements.txt` and `constants.py` files will be added to the currently existing ones, trying to keep\n the values set by other plugins.\n\n## How to use pybuilder_archetype_api\n\n\u003e **NOTICE**: This plugin only works on Windows due to its dependency with pybuilder_archetype_base PyBuilder plugin.\nUsing this plugin in other OS shall not work properly. Multi-platform support soon.\n\nAdd plugin dependencies to your `build.py` (it requires [pybuilder_archetype_base](https://github.com/yeuk0/pybuilder-archetype-base) and [pybuilder_pycharm_workspace](https://github.com/yeuk0/pybuilder-pycharm-workspace)\nto work properly):\n\n```python\nuse_plugin('pypi:pybuilder_pycharm_workspace')\nuse_plugin('pypi:pybuilder_archetype_base')\nuse_plugin('pypi:pybuilder_archetype_api')\n```\n\nConfigure the plugin within your `init` function:\n\n```python\n@init\ndef initialise(project):\n    project.set_property('project_base_path', project_path)\n```\n\nThis will tell the plugin which is the project location in the filesystem. `project_base_path` property value should\n be always the same.\n\nLaunch the task with:\n\n```console\n(venv) C:\\Users\\foo\\PycharmProjects\\bar\u003e pyb create_archetype_api\n```\n\n### `build.py` file recommended\n\nCheck [pybuilder_archetype_base `build.py` recommendation](https://github.com/yeuk0/pybuilder-archetype-base#buildpy-file-recommended).\n\n## Properties\n\nPlugin has next properties with provided defaults\n\n| Name | Type | Default Value | Description |\n| --- | --- | --- | --- |\n| project_base_path | Path | None | Project's path in filesystem (same as `build.py` file). Mandatory |\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyeuk0%2Fpybuilder-archetype-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyeuk0%2Fpybuilder-archetype-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyeuk0%2Fpybuilder-archetype-api/lists"}