Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ishangavidusha/httpserver
A lightweight, feature-rich HTTP server implementation for MicroPython environments. This server supports basic HTTP methods, CORS and more.
https://github.com/ishangavidusha/httpserver
http http-server micropython micropython-esp32 micropython-esp8266 python sse
Last synced: 2 days ago
JSON representation
A lightweight, feature-rich HTTP server implementation for MicroPython environments. This server supports basic HTTP methods, CORS and more.
- Host: GitHub
- URL: https://github.com/ishangavidusha/httpserver
- Owner: ishangavidusha
- License: mit
- Created: 2024-08-15T07:17:57.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-18T06:51:20.000Z (4 months ago)
- Last Synced: 2024-11-06T11:50:03.502Z (about 2 months ago)
- Topics: http, http-server, micropython, micropython-esp32, micropython-esp8266, python, sse
- Language: Python
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MicroPython HTTP Server
A lightweight, feature-rich HTTP server implementation for MicroPython environments. This server supports basic HTTP methods, CORS, and more, optimized for single-threaded microcontroller environments.
## Features
- Support for HTTP methods: GET, POST, PUT, DELETE, OPTIONS
- CORS (Cross-Origin Resource Sharing) support
- Query parameter parsing
- JSON request/response handling
- Static file serving
- Customizable logging
- Error handling with custom HTTP errors
## Requirements
- MicroPython environment
- `socket` and `json` modules (usually included in MicroPython)
## Installation
1. Copy the `server` directory to your MicroPython device.
2. Create your main application file (e.g., `main.py`) that imports and uses the server.
## Usage
Here's a basic example of how to use the server:
```python
from server.server import HTTPServer, Response, HTTPError
server = HTTPServer(port=8080, log_level='DEBUG', max_request_size=16384)
# Configure CORS
server.set_cors_config(
allow_origins=['*'],
allow_methods=['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS'],
allow_headers=['Content-Type', 'Authorization'],
allow_credentials=True,
max_age=3600
)
@server.route('/', methods=['GET'])
def home(query_params, headers, body):
name = query_params.get('name', 'Guest')
return Response(f"
Welcome to MicroPython HTTP Server, {name}!
")
@server.route('/api/data', methods=['GET', 'POST'])
def api_data(query_params, headers, body):
if headers.get('content-type') == 'application/json':
data = HTTPServer.parse_json(body)
response_data = {
"message": "Data received",
"data": data,
"query_params": query_params
}
return Response(response_data)
raise HTTPError(400, "Invalid Content-Type")
@server.route('/static/style.css', methods=['GET'])
def serve_css(query_params, headers, body):
return HTTPServer.serve_file('static/style.css', 'text/css')
if __name__ == '__main__':
server.start()
```
## API Reference
### HTTPServer
The main server class.
#### Constructor
```python
HTTPServer(port=80, log_level='INFO', max_request_size=8192, cors_config=None)
```
- `port`: The port to run the server on (default: 80)
- `log_level`: Logging level (default: 'INFO')
- `max_request_size`: Maximum allowed request size in bytes (default: 8192)
- `cors_config`: CORS configuration (default: None)
#### Methods
- `start()`: Start the server
- `route(path, methods=None)`: Decorator to register a route
- `set_cors_config(...)`: Configure CORS settings
- `serve_file(file_path, content_type)`: Serve a static file
- `parse_json(body)`: Parse JSON data
### Response
Class for creating HTTP responses.
#### Constructor
```python
Response(body='', status_code=200, headers=None)
```
### HTTPError
Custom exception for HTTP errors.
#### Constructor
```python
HTTPError(status_code, message)
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is open source and available under the [MIT License](LICENSE).