BoneShield

Express-like Python backend framework with MongoDB (local + Atlas), JWT, and WebSockets.

Default port: 313.

Install

pip install boneshield

Create a project

mkdir my-api
cd my-api
boneshield make
python main.py

Quick example

from boneshield import App, connect_mongo, makeResponse, jwt, sockets

app = App()
db = connect_mongo()
io = sockets(app)

@app.get("/health")
async def health(req):
    return makeResponse(200, data={"ok": True})

@app.post("/login")
async def login(req):
    body = await req.json()
    token = jwt.sign({"email": body.get("email")})
    return makeResponse(200, data={"token": token})

@io.on("ping")
async def on_ping(socket, data):
    await socket.emit("pong", data)

app.run()  # port 313

Docs

After boneshield make, open GUIDE.md for the full API reference.

Commands

boneshield make          # scaffold project in current directory
boneshield make --force  # overwrite existing scaffold files
boneshield --help
boneshield --version