Skip to main content

ramka - a simple Python web framework

Project description

ramka

Tests Linting Code style: black Imports: isort linting: pylint

ramka (a Polish word for a small frame) is a very simple web framework written in Python. It is based on a very good course Building Your Own Python Web Framework by testdriven.io which I highly recommend.

Please bear in mind that at the moment only very basic functionality is implemented and that this framework is far from being finished. Having said that, I do have some ideas for the future.

At the moment, you can define some routes and then serve the content (HTML, text, JSON) to the client. You can use dynamic routes and serve templates and static files (like stylesheets and images). And that's it. A framework is probably a big word for it but there is some potential for it to grow.

As I said it's still a work in progress. Some features I am planning to add:

  • database support - there are no plans to implement custom ORM, but integrating one of the existing ones (like SQLAlchemy) is probably a good start,
  • authentication - it can use databases or some different method,
  • plugins - the goal is to add a plugin mechanism and add more features as installable plugins.

There will be probably more but it's difficult for me to say at the moment. Anyway, I would treat this as a learning project rather than a real framework. Feel free to try it out and send me any feedback.

Documentation

The documentation is available at https://ramka.readthedocs.io/.

Installation

To install the package using pip, run the following command:

pip install ramka

To add it as a poetry dependency, run:

poetry add ramka

License

MIT

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

ramka-0.1.2.tar.gz (13.1 kB view hashes)

Uploaded Source

Built Distribution

ramka-0.1.2-py3-none-any.whl (18.7 kB view hashes)

Uploaded Python 3

Supported by

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