Skip to main content

Lightweight web framework for building APIs and backends

Project description

Tests Coveralls CodeFactor

Lightweight web framework (wink, wink) for building APIs and backends. Reasonably fast in execution, quite fast for development. 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-RESTX 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


Download files

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

Source Distribution

kristall-0.2.1.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

kristall-0.2.1-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file kristall-0.2.1.tar.gz.

File metadata

  • Download URL: kristall-0.2.1.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

File hashes

Hashes for kristall-0.2.1.tar.gz
Algorithm Hash digest
SHA256 b9ae869de29068d1e8439cb57959d649001816661141fa5ce23db483f28178fa
MD5 26c0ba2129c1d1de24d3fd4f24349de1
BLAKE2b-256 b7fabdb25a08133b968f10f49600bd6bb3e8eddb2ef498449d38ead7e272d4e6

See more details on using hashes here.

File details

Details for the file kristall-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: kristall-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

File hashes

Hashes for kristall-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 207d7063ee99958e9a109ac1c1ae64b2fbbba841d002ac351167d51f722fc747
MD5 7df64e56d9d07dc330b9ea44bc2c9436
BLAKE2b-256 2602df7969726241f4a936c8bf3b7894b2eecae2667252799e428a43c3af9317

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