Skip to main content

The web framework for inventors

Project description

Emmett

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["Api-Key"] == "foobar"
    
def not_authorized():
    response.status = 401
    return {'error': 'not authorized'}

@app.route(methods='get')
@service.json
@requires(is_authenticated, otherwise=not_authorized)
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}

pip version Tests Status

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.7 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

Emmmett 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

emmett-2.4.13.tar.gz (420.4 kB view details)

Uploaded Source

Built Distribution

emmett-2.4.13-py3-none-any.whl (461.3 kB view details)

Uploaded Python 3

File details

Details for the file emmett-2.4.13.tar.gz.

File metadata

  • Download URL: emmett-2.4.13.tar.gz
  • Upload date:
  • Size: 420.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.4 Linux/5.15.0-1023-azure

File hashes

Hashes for emmett-2.4.13.tar.gz
Algorithm Hash digest
SHA256 34a8121bbb4cde0b4c394f72952c8428d1cebb1746699eb91c9525704ca95eae
MD5 4e5304cc32a99086cedfd809e296fa4c
BLAKE2b-256 06e3e67ace378343f7b6689872979ba72edadca30935b2bf5db3dce9a7eccfeb

See more details on using hashes here.

File details

Details for the file emmett-2.4.13-py3-none-any.whl.

File metadata

  • Download URL: emmett-2.4.13-py3-none-any.whl
  • Upload date:
  • Size: 461.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.4 Linux/5.15.0-1023-azure

File hashes

Hashes for emmett-2.4.13-py3-none-any.whl
Algorithm Hash digest
SHA256 4938086939cc21cc842db8ff674bd993e8c2d744c93d20ac077309f632f1dc2a
MD5 5cf82ff7346a2044e5fc02ba097ee58e
BLAKE2b-256 d7b11e14816a7ee26524c737da510e9b7bc8758709ede591cfd590d5300d8c4e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page