{"id":16812862,"url":"https://github.com/serathius/muffin-peewee-async","last_synced_at":"2025-06-18T03:34:46.109Z","repository":{"id":57443850,"uuid":"99097623","full_name":"serathius/muffin-peewee-async","owner":"serathius","description":"Peewee integration to Muffin framework using peewee-async","archived":false,"fork":false,"pushed_at":"2017-08-09T11:58:21.000Z","size":9,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-17T11:21:32.714Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/serathius.png","metadata":{"files":{"readme":"README.rst","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":"2017-08-02T09:22:31.000Z","updated_at":"2017-08-02T11:20:47.000Z","dependencies_parsed_at":"2022-09-10T18:50:48.611Z","dependency_job_id":null,"html_url":"https://github.com/serathius/muffin-peewee-async","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/serathius/muffin-peewee-async","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serathius%2Fmuffin-peewee-async","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serathius%2Fmuffin-peewee-async/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serathius%2Fmuffin-peewee-async/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serathius%2Fmuffin-peewee-async/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serathius","download_url":"https://codeload.github.com/serathius/muffin-peewee-async/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serathius%2Fmuffin-peewee-async/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260483188,"owners_count":23016080,"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":[],"created_at":"2024-10-13T10:23:44.132Z","updated_at":"2025-06-18T03:34:41.095Z","avatar_url":"https://github.com/serathius.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Muffin Peewee Async\n#############\n\n.. _description:\n\nMuffin Peewee Async -- Peewee integration to Muffin framework using peewee-async.\n\nBased on https://github.com/klen/muffin-peewee with an ability to execute asynchronous queries.\n\n\nInstallation\n=============\n\n**Muffin Peewee Async** should be installed using pip: ::\n\n    pip install muffin-peewee-async\n\n\nUsage\n=====\n\nAdd `muffin_peewee_async` to `PLUGINS` in your Muffin Application configuration.\n\nOr install it manually like this: ::\n\n    db = muffin_peewee_async.Plugin(**{'options': 'here'})\n\n    app = muffin.Application('test')\n    app.install(db)\n\n\nOptions\n-------\n\n`PEEWEE_ASYNC_CONNECTION` -- connection string to your database (postgres://postgres:postgres@127.0.0.1)\n\n`PEEWEE_ASYNC_CONNECTION_PARAMS` -- Additional params for connection ({})\n\n`PEEWEE_ASYNC_MIGRATIONS_PATH` -- path to migration folder (migrations)\n\nQueries\n-------\n\n::\n    import peewee_async\n\n    @app.ps.peewee_async.register\n    class Test(peewee.Model):\n        data = peewee.CharField()\n\n\n    @app.register\n    async def view(request):\n        tests = await peewee_async.select(Test.select())\n        return [t.data for t in tests]\n\n\nMigrations\n----------\n\nCreate migrations: ::\n\n    $ muffin example:app pw_create [NAME] [--auto]\n\n\nRun migrations: ::\n\n    $ muffin example:app pw_migrate [NAME] [--fake]\n\n\nRollback migrations: ::\n\n    $ muffin example:app pw_rollback NAME\n\n\nLoad/Dump data to CSV\n---------------------\n\nDump table `test` to CSV file: ::\n\n    $ muffin example:app pw_dump test\n\n\nLoad data from CSV file to table `test`: ::\n\n    $ muffin example:app pw_load test\n\n\n.. _bugtracker:\n\nBug tracker\n===========\n\nIf you have any suggestions, bug reports or\nannoyances please report them to the issue tracker\nat https://github.com/serathius/muffin-peewee-async/issues\n\n.. _contributing:\n\nContributing\n============\n\nDevelopment of Muffin Peewee Async happens at: https://github.com/serathius/muffin-peewee-async\n\n\nContributors\n=============\n\n* serathius (Marek Siarkowicz)\n\n.. _license:\n\nLicense\n=======\n\nLicensed under a `MIT license`_.\n\n.. _links:\n\n.. _MIT license: http://opensource.org/licenses/MIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserathius%2Fmuffin-peewee-async","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserathius%2Fmuffin-peewee-async","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserathius%2Fmuffin-peewee-async/lists"}