https://github.com/botsarefuture/flask_autosec
https://github.com/botsarefuture/flask_autosec
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/botsarefuture/flask_autosec
- Owner: botsarefuture
- License: mit
- Created: 2024-12-12T17:21:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-11-30T16:07:05.000Z (7 months ago)
- Last Synced: 2025-12-02T23:31:57.057Z (7 months ago)
- Language: Python
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FlaskAutoSec
FlaskAutoSec is a library for integrating security features into a Flask application. It includes functionalities for mode management, SEC violation handling, request reporting, blacklist checking, and rate-limiting.
## Installation
```bash
pip install git+https://github.com/botsarefuture/flask_autosec.git
```
## Usage
```python
from flask import Flask
from flask_autosec import FlaskAutoSec
app = Flask(__name__)
security = FlaskAutoSec()
security.init_app(app)
if __name__ == '__main__':
app.run()
```
### Running with Gunicorn
When deploying your Flask application with Gunicorn, FlaskAutoSec ensures that only one scheduler instance runs across multiple worker processes. This is achieved using a file-based lock mechanism.
**Example Command:**
```bash
gunicorn -w 4 -b 0.0.0.0:8000 your_application:app
```
**Notes:**
- The scheduler lock file is located at `/tmp/flask_autosec_scheduler.lock`. Ensure that the application has the necessary permissions to create and modify this file.
- FlaskAutoSec automatically detects if it's running under Gunicorn and handles scheduler initialization accordingly to prevent multiple instances.
## Documentation
Detailed documentation can be found in the `docs/` folder.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.