Peewee integration for API Star.
Project description
API Star Peewee ORM
- Version: 0.2.0
- Status: Production/Stable
- Author: José Antonio Perdiguero López
Peewee integration for API Star.
Features
This library provides:
- Event hooks to handle connections and commit/rollback behavior based on exceptions in your views.
- Migrations support with a command-line interface to interact with them.
Quick start
Install API Star Peewee ORM:
pip install apistar-peewee-orm
Create an API Star application adding components and event hooks:
from apistar import App
from apistar_peewee_orm import PeeweeDatabaseComponent, PeeweeTransactionHook
routes = []
components = [
PeeweeDatabaseComponent(url='sqlite://'),
]
event_hooks = [
PeeweeTransactionHook(),
]
app = App(routes=routes, components=components, event_hooks=event_hooks)
Your models now should inherit from a base model defined in this library:
import peewee
from apistar_peewee_orm import Model
class PuppyModel(Model):
name = peewee.CharField()
Full Example
import typing
import peewee
from apistar import App, http, Route, types, validators
from apistar_peewee_orm import Model, PeeweeDatabaseComponent, PeeweeTransactionHook
class PuppyModel(Model):
name = peewee.CharField()
class PuppyType(types.Type):
id = validators.Integer(allow_null=True, default=None)
name = validators.String()
def list_puppies() -> typing.List[PuppyType]:
return [PuppyType(puppy) for puppy in PuppyModel.select()]
def create_puppy(puppy: PuppyType, raise_exception: http.QueryParam) -> http.JSONResponse:
if raise_exception:
raise Exception
model = PuppyModel.create(**puppy)
return http.JSONResponse(PuppyType(model), status_code=201)
routes = [
Route('/puppy/', 'POST', create_puppy),
Route('/puppy/', 'GET', list_puppies),
]
components = [
PeeweeDatabaseComponent(url='sqlite://'),
]
event_hooks = [
PeeweeTransactionHook(),
]
app = App(routes=routes, components=components, event_hooks=event_hooks)
CLI Application
An application will be installed along with this library to provide full support for migrations and some other features of Peewee and API Star.
$ apistar-peewee-orm --help
usage: orm [-h] [-s SETTINGS] [-q | -v] [--dry-run]
{status,upgrade,downgrade,delete,create} ... app
positional arguments:
app API Star application path
(<package>.<module>:<variable>)
optional arguments:
-h, --help show this help message and exit
-s SETTINGS, --settings SETTINGS
Module or object with Clinner settings in format
"package.module[:Object]"
-q, --quiet Quiet mode. No standard output other than executed
application
-v, --verbose Verbose level (This option is additive)
--dry-run Dry run. Skip commands execution, useful to check
which commands will be executed and execution order
Commands:
{status,upgrade,downgrade,delete,create}
status Database migrations and models status
upgrade Database migrations upgrade
downgrade Database migrations downgrade
delete Delete a migration
create Create a new migration
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
apistar-peewee-orm-0.2.0.tar.gz
(17.1 kB
view hashes)
Built Distribution
Close
Hashes for apistar_peewee_orm-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e8ae9bcf6151474abd8334ccf193dd49c280d5f0d929107c9edf1db47f68063 |
|
MD5 | 6daf30626602719466188ebbf04c5da1 |
|
BLAKE2b-256 | 9d35bac4dbdffd65fe5262b521a8b747784bc3f7cbff6cf3a84dbe8a1494ac56 |