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.
  • Flexible Error Handling: Easily handle HTTP errors with use of error_handler(<http_code).
  • 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, current_request

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

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

app.init_all("statics")

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

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

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

    return render_template(app, "test.html")

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

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

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

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

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

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

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

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

@app.route("/jinja/string")
def jinja_string():
    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.
  • adding websockets support (2.0.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-2.0.1.tar.gz (10.2 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-2.0.1-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nebula_core-2.0.1.tar.gz
Algorithm Hash digest
SHA256 9b370c57b86a437666cd15cca808fa19035a312d450daf0fd20dba1d28afe5bd
MD5 4073a0eba0e6371dd9d0631a9bf1a715
BLAKE2b-256 2f0a7b90d2d77d16a1dfa9b3759f1cd5b6b7e713c4d3f03c1eb1f2d25a65ab6e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nebula_core-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 9.6 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-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b419287b550807ea78875f5fa890a58f1d9b1455c172132caa0fcab491ac0d5c
MD5 c5ade044d319b31a33ca36b5b2469314
BLAKE2b-256 69d55adb3b3dc4ab27bd176dd50d6b98cbd79a405b2a642091121014d8b8110c

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