Skip to main content

Nebula is a lightweight Python backend framework with middleware and routing, built on top of the werkzeug. It allows you to create web applications quickly with simple, decorator-based routing.

Project description

Nebula

PyPI Stars Contributors

Nebula is a lightweight Python backend framework with middleware and routing, built on top of the werkzeug module. It allows you to create web applications quickly with simple, decorator-based routing.

Features

  • Decorator-based Routing: Define your routes with simple and intuitive decorators.
  • Template Loading: Easily load and serve HTML templates from a designated directory.
  • Statics Loading: Easily load and serve files from designated directory.
  • Middleware Support: before_request and after_request hooks for flexible request handling.
  • Easy to Use: Get a server up and running in just a few lines of code.

Installation

Install Nebula from PyPI:

pip install nebula-core

or clone and install from GitHub.

git clone https://github.com/VxidDev/nebula.git
cd nebula
pip install .

Usage

Here's a basic example of creating a simple web server with Nebula.

main.py:

from nebula import Nebula , Response

from nebula.utils import (
    jsonify, htmlify, init_static_serving , load_template , render_template , init_template_renderer , render_template_string,
    init_template_path
)

app = Nebula(__file__ , "localhost", 8000, False)

init_static_serving(app, "statics")
init_template_path(app)
init_template_renderer(app)

jinja_template = """
    <h1>{{ APP.host + ":" + APP.port|string }}</h1>
"""

@app.route("/" , methods=["GET" , "POST"])
def main(request):
    if request.method == "POST":    
        data = request.get_json()

        return jsonify({"greet": f"Hi, {data.get('name', 'default')}!"})

    return render_template(app, "test.html")

@app.route("/greet/<name>")
def greet(request, name):
    return htmlify(f"<h1>Hi, {name}!</h1>")

@app.route("/fruits")
def jsonTest(request):
    return jsonify({
        "fruits": {
            "apples": 6,
            "pears": 10,
            "mangos": 9
        } 
    })

@app.error_handler(405)
def method_not_allowed(request):
    return htmlify("<h1>Cant do that :[</h1>", 405)

@app.error_handler(404)
def not_found(request):
    return htmlify("<h1>Cant find that :(</h1>", 404)

@app.error_handler(500)
def doesnt_work(request):
    return htmlify("<h1>Internal Error!</h1>", 500)

@app.route("/internal-error")
def error(request):
    return Response(f"Error!", 500)

@app.route("/api", methods=["POST"])
def api(request):
    return jsonify({"a": 1, "b": 2, "c": 3}[request.get_json().get("item", "a")])

@app.route("/jinja")
def jinja(request):
    return render_template(app, "jinja_template.html", APP=app)

@app.route("/jinja/string")
def jinja_string(request):
    return htmlify(render_template_string(app, jinja_template, APP=app))

app.run()

Run your app:

python main.py

Open your browser and navigate to http://localhost:8000 to see your page.

Contributions <3

amogus-gggy - refactoring Nebula 0.2.0. Huge thank you!

License

This project is licensed under the MIT License - see the LICENSE file for 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

nebula_core-1.2.1.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nebula_core-1.2.1-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file nebula_core-1.2.1.tar.gz.

File metadata

  • Download URL: nebula_core-1.2.1.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for nebula_core-1.2.1.tar.gz
Algorithm Hash digest
SHA256 9f49559f762cd8604ef635a12483b770689c9e11938dc8a922005ecbecf39dfd
MD5 bb360376792357772215a1a6429d0e25
BLAKE2b-256 74bafd5b228f8c6024337ae27fc597addbe50ef4e4a14e5a4368354fb3f2d345

See more details on using hashes here.

File details

Details for the file nebula_core-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: nebula_core-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for nebula_core-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 555dd4528aff41f649e58282b08a87762f3057ee4cd16dcb75df44f6756cbf39
MD5 267a6618e0fa93b419d4f12a674dd73e
BLAKE2b-256 4b09ba4e01e5cb4b0f8f6ccfb57f19d669a08a54468696098e2e5daf4d8b0bb8

See more details on using hashes here.

Supported by

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