A high-level Python REST web framework based on Flask, Rick and RickDb.
Project description
Welcome to Pokie
Pokie is an API-oriented modular web framework built on top of Flask, Rick and Rick-db libraries, following three-layer and clean architecture design principles.
It features a object-oriented design, borrowing from common patterns found in other languages, such as dependency injection, service location, factories and object composition. It also offers the following functionality:
- Modular design;
- Dependency registry;
- CLI command support;
- Jobs (objects invoked periodically to perform a task);
- Fixtures;
- Unit testing support with pytest;
- Code generation;
- REST-oriented service design;
- Compatibility with Flask;
For detailed information, please check the Documentation
TL; DR; tutorial
- Create the application entrypoint, called main.py:
from rick.resource.config import EnvironmentConfig
from pokie.config.template import BaseConfigTemplate, PgConfigTemplate, TestConfigTemplate
from pokie.core import FlaskApplication
from pokie.core.factories.pgsql import PgSqlFactory
class Config(EnvironmentConfig, BaseConfigTemplate, PgConfigTemplate, TestConfigTemplate):
# @todo: add your config options or overrides here
pass
def build_pokie():
# load configuration from ENV
cfg = Config().build()
# modules to load & initialize
modules = [
#@ todo: add your modules here
]
# factories to run
factories = [
PgSqlFactory,
# @todo: add additional factories here
]
# build app
pokie_app = FlaskApplication(cfg)
flask_app = pokie_app.build(modules, factories)
return pokie_app, flask_app
main, app = build_pokie()
if __name__ == '__main__':
main.cli()
- Use our application to scaffold a module:
$ python3 main.py codegen:module my_module_name .
- Add your newly created module to the module list on main.py:
(...)
# modules to load & initialize
modules = [
'my_module_name', # our newly created module
]
(...)
- Implement the desired logic in the module
Running tests with tox
- Install tox & tox-docker:
$ pip install -r requirements-test.txt
- Run tests:
$ tox [-e py<XX>]
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
Pokie-0.8.0.tar.gz
(63.3 kB
view hashes)