{"id":23509024,"url":"https://github.com/pinecrew/joey","last_synced_at":"2026-04-28T13:34:01.629Z","repository":{"id":57438164,"uuid":"286559705","full_name":"pinecrew/joey","owner":"pinecrew","description":"Async web framework on top of fastapi and orm","archived":false,"fork":false,"pushed_at":"2022-04-12T15:51:55.000Z","size":91,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-13T15:57:04.589Z","etag":null,"topics":["fastapi","framework","joey","orm","python","web"],"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/pinecrew.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-08-10T19:17:36.000Z","updated_at":"2022-04-10T15:05:29.000Z","dependencies_parsed_at":"2022-08-27T23:20:45.899Z","dependency_job_id":null,"html_url":"https://github.com/pinecrew/joey","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/pinecrew/joey","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinecrew%2Fjoey","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinecrew%2Fjoey/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinecrew%2Fjoey/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinecrew%2Fjoey/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pinecrew","download_url":"https://codeload.github.com/pinecrew/joey/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinecrew%2Fjoey/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260977082,"owners_count":23091531,"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","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":["fastapi","framework","joey","orm","python","web"],"created_at":"2024-12-25T11:37:03.131Z","updated_at":"2026-04-28T13:34:01.566Z","avatar_url":"https://github.com/pinecrew.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# joey\n\n[![](https://img.shields.io/pypi/v/joey.svg)](https://pypi.org/project/joey/)\n[![](https://img.shields.io/pypi/l/joey.svg)](https://github.com/pinecrew/joey/blob/master/LICENSE)\n\nAsync web framework on top of [fastapi](https://pypi.org/project/fastapi/) and [orm](https://pypi.org/project/orm/)\n\n# How to start\nLet's create demo project\n```sh\n$ mkdir demo-project\n$ cd demo-project\n$ pipenv install joey\n$ pipenv shell\n$ joey init\n```\n\nJoey will create the following project structure\n```sh\n.\n├── alembic.ini\n├── asgi.py\n├── migrations\n│   ├── env.py\n│   ├── script.py.mako\n│   └── versions\n└── settings\n    ├── common.py\n    ├── common.yml\n    ├── development.py\n    └── __init__.py\n```\n\nLet's add the application to the given project structure\n```sh\n$ joey add hello\n# or with autoregister parameter\n$ joey add -a hello\n```\n\nJoey will add the following files in a separate folder\n```sh\n.\n└── hello\n    ├── __init__.py\n    ├── models.py\n    └── routes.py\n```\n\nIf you use `-a` flag then **joey** automatic register your app and route in project settings file\n```yaml\nAPPLICATIONS:\n- hello\nROUTES:\n  hello:\n    prefix: /hello\n    tags:\n    - hello\n```\notherwise manually edit `settings/common.yml` file.\n\nNow implement model in file  `hello/models.py`\n```py\nclass Item(Model):\n    fields = {\n        \"id\": orm.Integer(primary_key=True),\n        \"text\": orm.Text(),\n    }\n```\n\nImplement a simple route in `hello/routes.py`, than can access to database\n```py\nfrom fastapi import APIRouter, HTTPException\nfrom pydantic import BaseModel\n\n\nfrom hello.models import Item\n\n\nclass ItemResponse(BaseModel):\n    text: str\n\n\nrouter = APIRouter()\n\n@router.get('/{id}', response_model=ItemResponse)\nasync def item(id: int) -\u003e ItemResponse:\n    try:\n        return await Item.objects.get(id=id)\n    except Item.DoesNotExist:\n        raise HTTPException(status_code=404, detail='Item not found')\n```\n\n\nNext step - create a database, then migrate it and add a couple of elements\n```sh\n$ joey revise 'init database'\n$ joey migrate\n$ sqlite3 db.sqlite \"insert into items (text) values ('hello'), ('joe here');\"\n```\n\nEverything is ready, now you can start with uvicorn\n```sh\n$ joey run\n# or\n$ uvicorn asgi:app --reload\n```\n\nAnd request data with Swagger UI by `http://localhost:8000/docs`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinecrew%2Fjoey","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpinecrew%2Fjoey","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinecrew%2Fjoey/lists"}