Skip to main content

Lightweight web framework for building APIs and backends

Project description

Travis CI CodeCov CodeFactor

Lightweight web framework (wink, wink) for building APIs and backends. Reasonably fast in execution, developer friendly. If you need gazillions of requests served by single process in a second then there are better options than Kristall. I’m happy when it’s not slower than Flask.

Why

Some frameworks suck here, others suck there and none is good at all things I want. I decided to build a WSGI application tool that’s based on Werkzeug and is simpler than Flask. Sure, there are Flask extensions that make writing REST APIs simpler like Flask-RESTFul and Flask-RESTPlus but they are built on top of Flask and do many extra things that are better done by others, or not done at all. I wanted something that is somewhere in between Falcon and Flask. Simplicity of Falcon with convenience of Flask.

But since not everything sucks in Falcon I’d grab some ideas, like resourceful routing without need to subclass specific Resource base class, or only static route registration.

What

  • resourceful routing
  • static route registration
  • only JSON content type supported
  • very limited automatic coercion to JSON

That’s it for now.

Future developments:

  • JWT-based resource access control (optional)
  • CORS support (optional)

What not

  • no decorator-based route registration - there’s only one way to register routes and it is explicit
  • no built-in support for any other content type than application/json on both input and output
  • no fancy JSON de/encoding, only builtin json module is used in default JSON handling - use schema parsing/validating library eg. Marshmallow or Colander if you need anything beyond that; default behaviour may be customised to some degree by providing JSON decoder and encoder classes

How

Really very thin wrapper over Werkzeug utility functions and classes. Seriously, I’m not calling this a framework. Not yet. It consists of Application class that’s and entry point to runtime and Request/Response objects that in fact are Werkzeug’s built in wrappers reconfigured to support only JSON as transport media with some convenience methods.

Runtime dependencies

  • Python 3.7
  • Werkzeug 0.16

These are minimal versions of requirements.

Project details


Release history Release notifications

Download files

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

Files for kristall, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size kristall-0.0.1-py3-none-any.whl (13.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size kristall-0.0.1.tar.gz (12.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page