bustapi 0.1.0__tar.gz → 0.1.5__tar.gz

{bustapi-0.1.0 → bustapi-0.1.5}/.github/workflows/ci.yml

@@ -1,10 +1,7 @@
 name: BustAPI CI
 
 on:
-  push:
-    branches: ["main", "develop"]
-  pull_request:
-    branches: ["main"]
+  workflow_dispatch: {}
 
 jobs:
   test:

{bustapi-0.1.0 → bustapi-0.1.5}/.gitignore

@@ -145,4 +145,6 @@ ex.py.toml
 
 .zen*
 .mypy_*
-.ruff_*
+.ruff_*
+wheel/
+venv/

bustapi-0.1.5/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented here.
+
+## [0.1.1]
+- Added Jinja2 templating helper and `render_template` API
+- Added minimal OpenAPI JSON generator and `/openapi.json` endpoint
+- CI: Make workflows platform-aware for virtualenv and maturin invocations
+- CI: Flatten downloaded artifacts before PyPI publish
+
+## [0.1.0]
+- Initial release

{bustapi-0.1.0 → bustapi-0.1.5}/Cargo.lock

@@ -40,20 +40,15 @@ checksum = "b0674a1ddeecb70197781e945de4b3b8ffb61fa939a5597bcf48503737663100"
 
 [[package]]
 name = "async-compression"
-version = "0.4.29"
+version = "0.4.30"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5bee399cc3a623ec5a2db2c5b90ee0190a2260241fbe0c023ac8f7bab426aaf8"
+checksum = "977eb15ea9efd848bb8a4a1a2500347ed7f0bf794edf0dc3ddcf439f43d36b23"
 dependencies = [
- "brotli",
  "compression-codecs",
  "compression-core",
- "flate2",
  "futures-core",
- "memchr",
  "pin-project-lite",
  "tokio",
- "zstd",
- "zstd-safe",
 ]
 
 [[package]]
@@ -152,6 +147,7 @@ dependencies = [
  "http-body-util",
  "hyper",
  "hyper-util",
+ "num_cpus",
  "pyo3",
  "pyo3-asyncio",
  "pyo3-build-config",
@@ -197,16 +193,14 @@ checksum = "2fd1289c04a9ea8cb22300a459a72a385d7c73d3259e2ed7dcb2af674838cfa9"
 
 [[package]]
 name = "compression-codecs"
-version = "0.4.29"
+version = "0.4.30"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c7eea68f0e02c2b0aa8856e9a9478444206d4b6828728e7b0697c0f8cca265cb"
+checksum = "485abf41ac0c8047c07c87c72c8fb3eb5197f6e9d7ded615dfd1a00ae00a0f64"
 dependencies = [
  "brotli",
  "compression-core",
  "flate2",
- "futures-core",
  "memchr",
- "pin-project-lite",
  "zstd",
  "zstd-safe",
 ]
@@ -449,6 +443,12 @@ version = "0.4.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8"
 
+[[package]]
+name = "hermit-abi"
+version = "0.5.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fc0fef456e4baa96da950455cd02c081ca953b141298e41db3fc7e36b1da849c"
+
 [[package]]
 name = "http"
 version = "1.3.1"
@@ -818,17 +818,16 @@ checksum = "78bed444cc8a2160f01cbcf811ef18cac863ad68ae8ca62092e8db51d51c761c"
 dependencies = [
  "libc",
  "wasi 0.11.1+wasi-snapshot-preview1",
- "windows-sys",
+ "windows-sys 0.59.0",
 ]
 
 [[package]]
 name = "nu-ansi-term"
-version = "0.46.0"
+version = "0.50.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "77a8165726e8236064dbb45459242600304b42a5ea24ee2948e18e023bf7ba84"
+checksum = "d4a28e057d01f97e61255210fcff094d74ed0466038633e95017f5beb68e4399"
 dependencies = [
- "overload",
- "winapi",
+ "windows-sys 0.52.0",
 ]
 
 [[package]]
@@ -840,6 +839,16 @@ dependencies = [
  "autocfg",
 ]
 
+[[package]]
+name = "num_cpus"
+version = "1.17.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "91df4bbde75afed763b708b7eee1e8e7651e02d97f6d5dd763e89367e957b23b"
+dependencies = [
+ "hermit-abi",
+ "libc",
+]
+
 [[package]]
 name = "object"
 version = "0.36.7"
@@ -855,12 +864,6 @@ version = "1.21.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "42f5e15c9953c5e4ccceeb2e7382a716482c34515315f7b03532b8b4e8393d2d"
 
-[[package]]
-name = "overload"
-version = "0.1.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b15813163c1d831bf4a13c3610c05c0d03b39feb07f7e09fa234dac9b15aaf39"
-
 [[package]]
 name = "parking_lot"
 version = "0.12.4"
@@ -1190,7 +1193,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "233504af464074f9d066d7b5416c5f9b894a5862a6506e306f7b816cdd6f1807"
 dependencies = [
  "libc",
- "windows-sys",
+ "windows-sys 0.59.0",
 ]
 
 [[package]]
@@ -1304,7 +1307,7 @@ dependencies = [
  "slab",
  "socket2",
  "tokio-macros",
- "windows-sys",
+ "windows-sys 0.59.0",
 ]
 
 [[package]]
@@ -1441,9 +1444,9 @@ dependencies = [
 
 [[package]]
 name = "tracing-subscriber"
-version = "0.3.19"
+version = "0.3.20"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e8189decb5ac0fa7bc8b96b7cb9b2701d60d48805aca84a238004d665fcc4008"
+checksum = "2054a14f5307d601f88daf0553e1cbf472acc4f2c51afab632431cdcd72124d5"
 dependencies = [
  "nu-ansi-term",
  "sharded-slab",
@@ -1594,28 +1597,6 @@ dependencies = [
  "unicode-ident",
 ]
 
-[[package]]
-name = "winapi"
-version = "0.3.9"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
-dependencies = [
- "winapi-i686-pc-windows-gnu",
- "winapi-x86_64-pc-windows-gnu",
-]
-
-[[package]]
-name = "winapi-i686-pc-windows-gnu"
-version = "0.4.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
-
-[[package]]
-name = "winapi-x86_64-pc-windows-gnu"
-version = "0.4.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
-
 [[package]]
 name = "windows-link"
 version = "0.1.3"
@@ -1651,6 +1632,15 @@ dependencies = [
  "windows-link",
 ]
 
+[[package]]
+name = "windows-sys"
+version = "0.52.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d"
+dependencies = [
+ "windows-targets",
+]
+
 [[package]]
 name = "windows-sys"
 version = "0.59.0"

{bustapi-0.1.0 → bustapi-0.1.5}/Cargo.toml

@@ -29,6 +29,7 @@ tower-http = { version = "0.5", features = ["full"] }
 url = "2.0"
 anyhow = "1.0"
 thiserror = "1.0"
+num_cpus = "1.0"
 
 [build-dependencies]
 pyo3-build-config = "0.20"

{bustapi-0.1.0 → bustapi-0.1.5}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 BustAPI Team
+Copyright (c) 2024 GrandpaEJ
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

bustapi-0.1.5/PKG-INFO

@@ -0,0 +1,324 @@
+Metadata-Version: 2.4
+Name: bustapi
+Version: 0.1.5
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Dist: black>=24.8.0
+Requires-Dist: isort>=5.13.2
+Requires-Dist: maturin>=1.9.3
+Requires-Dist: pytest>=8.3.5
+Requires-Dist: pytest-asyncio>=0.24.0
+Requires-Dist: pytest-cov>=5.0.0
+Requires-Dist: ruff>=0.12.10
+Requires-Dist: typing-extensions>=4.0.0
+Requires-Dist: werkzeug>=2.0.0
+Requires-Dist: jinja2>=3.1
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: requests>=2.32.4
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: pytest>=7.0 ; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0 ; extra == 'dev'
+Requires-Dist: black>=22.0 ; extra == 'dev'
+Requires-Dist: mypy>=1.0 ; extra == 'dev'
+Requires-Dist: ruff>=0.1.0 ; extra == 'dev'
+Requires-Dist: pre-commit>=3.0 ; extra == 'dev'
+Requires-Dist: maturin>=1.0 ; extra == 'dev'
+Requires-Dist: mkdocs>=1.5 ; extra == 'docs'
+Requires-Dist: mkdocs-material>=9.0 ; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.20 ; extra == 'docs'
+Provides-Extra: dev
+Provides-Extra: docs
+License-File: LICENSE
+Summary: High-performance Flask-compatible web framework with async support
+Keywords: web,framework,async,performance,flask
+Author-email: BustAPI Team <hello@bustapi.dev>
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/bustapi/bustapi
+Project-URL: Documentation, https://bustapi.dev
+Project-URL: Repository, https://github.com/bustapi/bustapi.git
+Project-URL: Issues, https://github.com/bustapi/bustapi/issues
+
+# 🚀 BustAPI
+
+**High-Performance Python Web Framework Powered by Rust**
+
+BustAPI is a modern, fast Python web framework that combines the simplicity of Flask with the performance of Rust. Built with PyO3 and Tokio, it delivers **native Rust performance** while maintaining Python's ease of use.
+
+## ⚡ Performance
+
+BustAPI achieves **539+ RPS** compared to Flask's 452 RPS and FastAPI's 451 RPS - delivering **20% better performance** through its Rust-powered backend.
+
+| Framework | RPS | Improvement |
+|-----------|-----|-------------|
+| **BustAPI** | **539** | **Baseline** |
+| Flask | 451 | +20% slower |
+| FastAPI | 452 | +19% slower |
+
+*Benchmarks: 100 concurrent connections, 10,000 total requests*
+
+## 🎯 Key Features
+
+- **🔥 High Performance**: Rust-powered backend with Python ease-of-use
+- **🔄 Flask Compatible**: Drop-in replacement for most Flask applications  
+- **⚡ Async Support**: Native async/await support with Tokio runtime
+- **📚 Auto Documentation**: FastAPI-style automatic OpenAPI/Swagger UI
+- **🎨 Template Support**: Jinja2 template rendering out of the box
+- **🔧 Extension Support**: Compatible with popular Flask extensions
+- **🛡️ Type Safety**: Full type hints and Pydantic integration
+- **🌐 All HTTP Methods**: GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install bustapi
+```
+
+### Your First App
+
+```python
+from bustapi import BustAPI
+
+app = BustAPI()
+
+@app.route('/')
+def hello():
+    return {'message': 'Hello, World!'}
+
+@app.route('/users/<int:user_id>')
+def get_user(user_id):
+    return {'user_id': user_id, 'name': f'User {user_id}'}
+
+if __name__ == '__main__':
+    app.run(debug=True)
+```
+
+Visit `http://127.0.0.1:8000` to see your app in action!
+
+### Auto Documentation
+
+```python
+from bustapi import BustAPI
+
+app = BustAPI(
+    title="My API",
+    description="A high-performance API built with BustAPI",
+    version="1.0.0",
+    docs_url="/docs",      # Swagger UI
+    redoc_url="/redoc",    # ReDoc
+    openapi_url="/openapi.json"
+)
+
+@app.get("/users")
+def get_users():
+    """Get all users from the system."""
+    return {"users": []}
+
+@app.post("/users")
+def create_user():
+    """Create a new user."""
+    return {"message": "User created"}, 201
+```
+
+- **Swagger UI**: `http://127.0.0.1:8000/docs`
+- **ReDoc**: `http://127.0.0.1:8000/redoc`
+- **OpenAPI Schema**: `http://127.0.0.1:8000/openapi.json`
+
+## 🔧 HTTP Methods
+
+BustAPI supports all HTTP methods with convenient decorators:
+
+```python
+from bustapi import BustAPI
+
+app = BustAPI()
+
+@app.get('/items')
+def get_items():
+    return {'items': []}
+
+@app.post('/items')
+def create_item():
+    return {'message': 'Item created'}, 201
+
+@app.put('/items/<int:item_id>')
+def update_item(item_id):
+    return {'message': f'Item {item_id} updated'}
+
+@app.delete('/items/<int:item_id>')
+def delete_item(item_id):
+    return {'message': f'Item {item_id} deleted'}
+
+@app.patch('/items/<int:item_id>')
+def patch_item(item_id):
+    return {'message': f'Item {item_id} patched'}
+```
+
+## 🎨 Template Rendering
+
+Full Jinja2 support with template inheritance:
+
+```python
+from bustapi import BustAPI, render_template
+
+app = BustAPI()
+
+@app.route('/')
+def index():
+    return render_template('index.html', 
+                         title='BustAPI App',
+                         message='Welcome to BustAPI!')
+
+@app.route('/users')
+def users():
+    users = [{'name': 'Alice'}, {'name': 'Bob'}]
+    return render_template('users.html', users=users)
+```
+
+## 📊 Request Handling
+
+```python
+from bustapi import BustAPI, request
+
+app = BustAPI()
+
+@app.route('/data', methods=['POST'])
+def handle_data():
+    # JSON data
+    json_data = request.get_json()
+    
+    # Form data
+    form_data = request.form
+    
+    # Query parameters
+    args = request.args
+    
+    # Headers
+    headers = request.headers
+    
+    # Files
+    files = request.files
+    
+    return {
+        'json': json_data,
+        'form': dict(form_data),
+        'args': dict(args),
+        'headers': dict(headers)
+    }
+```
+
+## 🔄 Flask Migration
+
+BustAPI is designed as a drop-in replacement for Flask:
+
+```python
+# Flask code
+from flask import Flask, jsonify, request
+
+app = Flask(__name__)
+
+@app.route('/api/users', methods=['GET', 'POST'])
+def users():
+    if request.method == 'GET':
+        return jsonify({'users': []})
+    return jsonify({'message': 'User created'}), 201
+
+# BustAPI equivalent (same code!)
+from bustapi import BustAPI, jsonify, request
+
+app = BustAPI()
+
+@app.route('/api/users', methods=['GET', 'POST'])
+def users():
+    if request.method == 'GET':
+        return jsonify({'users': []})
+    return jsonify({'message': 'User created'}), 201
+```
+
+## 📚 Documentation & Examples
+
+- **[📖 Full Documentation](docs/)** - Complete guides and API reference
+- **[🎯 Examples](examples/)** - Working examples for all features
+- **[🚀 Quick Start Guide](docs/quickstart.md)** - Get started in minutes
+- **[🔧 API Reference](docs/api-reference.md)** - Complete API documentation
+
+## 🏗️ Production Deployment
+
+### Using Gunicorn
+
+```bash
+pip install gunicorn
+gunicorn -w 4 -b 0.0.0.0:8000 app:app
+```
+
+### Using Uvicorn
+
+```bash
+pip install uvicorn
+uvicorn app:app --host 0.0.0.0 --port 8000 --workers 4
+```
+
+### Docker
+
+```dockerfile
+FROM python:3.11-slim
+
+WORKDIR /app
+COPY requirements.txt .
+RUN pip install -r requirements.txt
+
+COPY . .
+EXPOSE 8000
+
+CMD ["gunicorn", "-w", "4", "-b", "0.0.0.0:8000", "app:app"]
+```
+
+## 🧪 Testing
+
+BustAPI includes a built-in test client:
+
+```python
+from bustapi.testing import TestClient
+
+def test_app():
+    client = TestClient(app)
+    
+    response = client.get('/')
+    assert response.status_code == 200
+    assert response.json() == {'message': 'Hello, World!'}
+    
+    response = client.post('/users', json={'name': 'Alice'})
+    assert response.status_code == 201
+```
+
+## 🤝 Contributing
+
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
+
+## 📄 License
+
+BustAPI is licensed under the MIT License. See [LICENSE](LICENSE) for details.
+
+## 🙏 Acknowledgments
+
+- Built with [PyO3](https://pyo3.rs/) for Python-Rust integration
+- Powered by [Tokio](https://tokio.rs/) for async runtime
+- Inspired by [Flask](https://flask.palletsprojects.com/) and [FastAPI](https://fastapi.tiangolo.com/)
+
+---
+
+**Made with ❤️ and ⚡ by the BustAPI team**
+