{"id":20371987,"url":"https://github.com/void-verse/void-proton","last_synced_at":"2026-03-10T11:33:40.769Z","repository":{"id":43167065,"uuid":"511097488","full_name":"void-verse/void-proton","owner":"void-verse","description":"A proton sized python framework for building backend web applications, from void. [PIP PACKAGE]","archived":false,"fork":false,"pushed_at":"2022-07-07T03:55:33.000Z","size":12,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"prod","last_synced_at":"2025-12-16T20:47:09.921Z","etag":null,"topics":["backend-framework","pip-package","python-package","web-framework","wsgi-server"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/void-proton","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/void-verse.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":"2022-07-06T10:49:41.000Z","updated_at":"2024-03-29T09:25:57.000Z","dependencies_parsed_at":"2022-09-26T21:02:08.727Z","dependency_job_id":null,"html_url":"https://github.com/void-verse/void-proton","commit_stats":null,"previous_names":["nandan-unni/proton-py"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/void-verse/void-proton","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/void-verse%2Fvoid-proton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/void-verse%2Fvoid-proton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/void-verse%2Fvoid-proton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/void-verse%2Fvoid-proton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/void-verse","download_url":"https://codeload.github.com/void-verse/void-proton/tar.gz/refs/heads/prod","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/void-verse%2Fvoid-proton/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30332343,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T05:25:20.737Z","status":"ssl_error","status_checked_at":"2026-03-10T05:25:17.430Z","response_time":106,"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":["backend-framework","pip-package","python-package","web-framework","wsgi-server"],"created_at":"2024-11-15T01:11:02.749Z","updated_at":"2026-03-10T11:33:35.746Z","avatar_url":"https://github.com/void-verse.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PROTON : A proton sized web framework\n\nProton is an Express inspired proton sized web framework for building backend web applications from [void](https://github.com/void-verse). Currently, it has features of adding routes, controllers and sending API responses (Refer the [example blog app](https://github.com/NandanunniAS/Nano-Blog-App) for reference). Defining models with custom field types is also available but is under development.\n\n**Status** : Under developement\n\u003cbr /\u003e\n\n### To run example app\n\n```bash\n$ pip3 install -r requirements.txt\n\n$ python3 main.py run:\u003cappname\u003e\n```\n\n## Documentation\n\n**Step 1**: Install proton and create folder structure\n\n```bash\n$ pip3 install proton-py\n\n$ touch models.py\n$ touch controllers.py\n$ touch routes.py\n$ touch main.py\n```\n\n\u003cbr /\u003e\n\n**Step 2**: Define your models\n\n```python\n# models.py\nfrom proton.db import model\n\nclass User(model.Model):\n    username = model.StringType('username', max_length=50, min_length=4, unique=True, required=True)\n    # define your model here\n```\n\n\u003cbr /\u003e\n\n**Step 2**: Define your controllers\n\n```python\n# controllers.py\nfrom proton.handler import Response\n\ndef index(req):\n    # define your controller here\n    return Response(status=200, data={\"msg\": \"message\"})\n```\n\n\u003cbr /\u003e\n\n**Step 3**: create a router and assign controllers with routes\n\n```python\n# routes.py\nfrom proton.handler import Router\nfrom .controllers import index\n\nrouter = Router()\nrouter.get(\"/\", index)\n```\n\n\u003cbr /\u003e\n\n**Step 4**: create proton app and assemble your router and models\n\n```python\n# main.py\nfrom proton import Proton, run\nfrom .routes import router\nfrom .models import User\n\napi = Proton()\n\napi.set_router('/api', router)\napi.set_models(User)\n\nrun(api)\n```\n\n\u003cbr /\u003e\n\n**Step 5**: Boot your models to db and run the server\n\n```bash\n$ python3 main.py run:db\n$ python3 main.py run:api\n```\n\nRefer the [example blog app](https://github.com/NandanunniAS/Nano-Blog-App) for folder structure. Working on a better documentation\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoid-verse%2Fvoid-proton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvoid-verse%2Fvoid-proton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoid-verse%2Fvoid-proton/lists"}