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.1.0.tar.gz (387.3 kB view details)

Uploaded Source

Built Distribution

Emmett-2.1.0-py3-none-any.whl (434.5 kB view details)

Uploaded Python 3

File details

Details for the file Emmett-2.1.0.tar.gz.

File metadata

  • Download URL: Emmett-2.1.0.tar.gz
  • Upload date:
  • Size: 387.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.3 CPython/3.8.6 Linux/5.4.0-1026-azure

File hashes

Hashes for Emmett-2.1.0.tar.gz
Algorithm Hash digest
SHA256 bafc76fceac236e5bd9d8e2b9198c45f303749c2e1f379dfd19e457b94d3a7e5
MD5 50d059e5b75e8eb1fc0d8006b88930b0
BLAKE2b-256 eb715b6b1da5f46c11de679312d3682e6db25902d5422e3bfef83c0e008475e0

See more details on using hashes here.

File details

Details for the file Emmett-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: Emmett-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 434.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.3 CPython/3.8.6 Linux/5.4.0-1026-azure

File hashes

Hashes for Emmett-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 65a4884cc81ce3ce89c8775c97bcfa4ff80ee9424160be7d507506f04b8ae752
MD5 8832d147164d7c137776f4089500ac36
BLAKE2b-256 929e5880ee87f204cde82a0b2ce10772776654e2ff1c813f174a1dd12659539a

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