Falcon Core Inspired by Django for Falcon API Framework.
Project description
falcon Core
Falcon Core Inspired by Django for Falcon API Framework.
Installation
pip install falcon-core
User guide
Starting project
falcon-core startproject api
Create project api and folder api
- api/
- api/manage.py
- apy/api/
- apy/api/__init__.py
- apy/api/settings.py
- apy/api/routes.py
- apy/api/wsgi.py
falcon-core startproject api .
Create project api in my location folder
- my_location/manage.py
- my_location/api/
- my_location/api/__init__.py
- my_location/api/settings.py
- my_location/api/routes.py
- my_location/api/wsgi.py
falcon-core startproject api folder
Create project api in folder
- folder/manage.py
- folder/api/
- folder/api/__init__.py
- folder/api/settings.py
- folder/api/routes.py
- folder/api/wsgi.py
Starting project app
python manage.py startapp example
Create app in project dir
- example/__init__.py
- example/resources.py
- example/routes.py
python manage.py startapp example.example1
Create app in app
- example/example1/__init__.py
- example/example1/resources.py
- example/example1/routes.py
python manage.py startapp example2.example3
- example2/__init__.py
- example2/example3/__init__.py
- example2/example3/resources.py
- example2/example3/routes.py
Create resource in example.resource.py
import falcon
from falcon_core.resources import Resource
class ExampleResource(Resource):
def on_get(self, req, resp, **kwargs):
resp.status = falcon.HTTP_OK
resp.media = {'key': 'value'}
Add resource to routes
example.routes.py
from falcon_core.routes import route
from example.resources import ExampleResource
routes = [
route('/example', ExampleResource()),
]
(1) api.resource.py
from falcon_core.routes import route, include
from example.routes import routes as example_routes
routes = [
route('', include(example_routes)),
]
(2) api.routes.py
from falcon_core.routes import route, include
routes = [
route('', include('example.routes')),
]
Add middleware
In api.settings.py
...
MIDDLEWARE = [
'module.MiddlewareOrMiddlewareInstance'
]
...
Add router converters
In api.settings.py
...
ROUTER_CONVERTERS = [
'name': 'module.Converter'
]
...
Change root routes
In api.settings.py
...
ROUTES = 'module.routes' # must have routes list
...
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
falcon_core-0.0.21.tar.gz
(9.3 kB
view hashes)
Built Distribution
Close
Hashes for falcon_core-0.0.21-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b11419ae76ae267e67a39ad1496f7ca7d57e0f456ce85c489fe63c7ef898a44d |
|
MD5 | 3ac545eb096c67da2272e02a0048246e |
|
BLAKE2b-256 | 1491261eb12fea08ff715c917389125a449d51b155d81a3dc893e0070715bd91 |