emmett-framework / emmett

The web framework for inventors

Emmett is a full-stack Python web framework designed with simplicity in mind.

The aim of Emmett is to be clearly understandable, easy to be learned and to be used, so you can focus completely on your product's features:

from emmett import App, request, response
from emmett.orm import Database, Model, Field
from emmett.tools import service, requires

class Task(Model):
    name = Field.string()
    is_completed = Field.bool(default=False)

app = App(__name__)
app.config.db.uri = "postgres://user:password@localhost/foo"
db = Database(app)
db.define_models(Task)
app.pipeline = [db.pipe]

def is_authenticated():
    return request.headers.get("api-key") == "foobar"
    
def not_authorized():
    response.status = 401
    return {'error': 'not authorized'}

@app.route(methods='get')
@requires(is_authenticated, otherwise=not_authorized)
@service.json
async def todo():
    page = request.query_params.page or 1
    tasks = Task.where(
        lambda t: t.is_completed == False
    ).select(paginate=(page, 20))
    return {'tasks': tasks}

Documentation

The documentation is available at https://emmett.sh/docs. The sources are available under the docs folder.

Examples

The bloggy example described in the Tutorial is available under the examples folder.

Status of the project

Emmett is production ready and is compatible with Python 3.8 and above versions.

Emmett follows a semantic versioning for its releases, with a {major}.{minor}.{patch} scheme for versions numbers, where:

• major versions might introduce breaking changes
• minor versions usually introduce new features and might introduce deprecations
• patch versions only introduce bug fixes

Deprecations are kept in place for at least 3 minor versions, and the drop is always communicated in the upgrade guide.

How can I help?

We would be very glad if you contributed to the project in one or all of these ways:

• Talking about Emmett with friends and on the web
• Adding issues and features requests here on GitHub
• Participating in discussions about new features and issues here on GitHub
• Improving the documentation
• Forking the project and writing beautiful code

License

Emmett is released under the BSD License.

However, due to original license limitations, some components are included in Emmett under their original licenses. Please check the LICENSE file for more details.

emmett's Issues

Caching docs chapter

Update official top level domains in validators

As seen on: web2py/web2py#817

Caching for templating system

Actually templating system parse and exec templates code per request.
I would like to cache the source of the template and use python compile() in combination with exec.

Update sessions documentation

With new SessionFSManager

CLI/app option to disable python code autoreloader

Validation order with dictionaries

Add examples folder

With bloggy from official tutorial

Production docs chapter

Stream files from folders

Add a method to stream file directly from a folder.
The current stream_file() should be converted to stream_fromDB() or something like that.

Add test client to app

Update of isListOf validator

Reference: web2py/web2py#810

Production Ready?

How far away is this project from being able to be run in the wild?

Email logger

Update `_default_validators`

Due to this: web2py/pydal@59bbde1

Will require newer version of pyDAL.

Port back 'options' utilities in `inDB` and `notInDB` validators

Add upgrade guide

Add a "join" method to sets in order to support loading of many/belongs relations

Something like:

class Author(Model):
    name = Field()
    region = Field()
    has_many('books')

class Book(Model):
    name = Field()
    year = Field('int')
    belongs_to('author')

authors_with_books = db(Author.region == "Italy").join('books').select()
books_with_authors = db(Book.year >= 2015).join('author').select()

Fields inheritance in DAL Models

This would allow subclassing Models.

Patterns docs chapter

Validation docs

List validators in documentation

'match' validator

Update sanitizer lib

Due to this: web2py/web2py#797

typo in docs

form weppy import Field, Form

python3 support

We need some tests

We really need tests.

• DAL layer
• Basic (app, global objects)
• Routing
• Sessions
• Caching
• Templating
• AppModules
• Extensions
• Translator
• Validations

Unify DAL/ModelsDAL and Auth/ModelsAuth

Actually is meaningless to use separate classes.

Tutorial

Please create full examples

Hello, your sample code in docs do not work out of the box.
Its not clear that the full code should be written.
For example i´m trying to understand how to create a form

your docs says

form weppy import Field, Form
from weppy.validators import inSet

@app.expose('/form')
def a():
simple_form = Form({
'name': Field(),
'number': Field('int'),
'type': Field(
validation={'in': ['type1', 'type2']}
)
})
if simple_form.accepted:
#do something
return dict(form=simple_form)

but this is not enough to create a valid form code

i´m not sure but i thing i need to add
from weppy import App
app = App(name)

and
if name == "main":
app.run()

Please be more patient with dummies like me and most of the people that follows you.

Regards

Debugging docs

SessionManager for disk storage

Add the ability to store sessions on disk.

Better way to define multiple and self references

Update validators nomenclature in documentation

Direct link to github

Please add a link to github in weppy.org

Udpate `Handler` documentation

Add new on_end method documentation in:

• quickstart
• request chapter

Python code auto-reloader

When loaded with builtin server

serializers.items ... module object has no attribute 'items'.

pydal\base.py line 477. for k, v in self.serializers.items():
There has been some discussion (web2py-users) about an issue in April, but its been throwing this error on the latest version.

Services docs chapter

Update DAL and Auth models documentation

Due to #7

Add a `remove` method to has_many sets on join tables

sdict may need an update

Inspect web2py/web2py@d6c565f

DAL should use app's logger

DAL now uses a separated logger: this cause duplicated entries in log on app's messages.

pyDAL v15.02 as a requirement

Waiting for the release.

Add `where` method to models and lambda conditions

Something like:

Event.where(lambda e: (e.start_at >= datetime(2015, 5, 20)) & (e.ends_at < datetime(2015, 6, 20)))

instead of

db((Event.start_at >= datetime(2015, 5, 20)) & (Event.ends_at < datetime(2015, 6, 20)))

Major error reloading Python

When I reloaded Python, I got this message on my screen:

uWSGI Error

Python application not found

And now I cannot access the Rascal anymore.
Can someone help please?

Template reloader should check `include` and `extends` blocks

Allow to specify field on has_many relations

Allow to create "scopes" on Model sets

Just an idea. Something like:

class Event(Model):
    name = Field()
    start_at = Field('datetime')
    ends_at = Field('datetime')
    speaker = Field()

    @scope('active')
    def get_active(cls):
        return (cls.start_at <= request.now) & (cls.ends_at > request.now)

so we can query:

Event.active().where(Event.name.startswith('foo'))
# and/or
db(Event.speaker == "john").active()

'list' validator

Languages docs chapter