Name | wavebox JSON |
Version |
1.0.1
JSON |
| download |
home_page | |
Summary | A compact, fast, and easy to use flask backend wrapper |
upload_time | 2023-10-05 11:39:57 |
maintainer | |
docs_url | None |
author | |
requires_python | >=3.10 |
license | |
keywords |
backend
performance
error handling
wrapper
development
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Wavebox: Clean, Compact, and Easy Flask Backend Wrapper
[![PyPI Version](https://img.shields.io/pypi/v/wavebox.svg)](https://pypi.org/project/wavebox/)
[![Python Versions](https://img.shields.io/pypi/pyversions/wavebox.svg)](https://pypi.org/project/wavebox/)
[![License](https://img.shields.io/pypi/l/wavebox.svg)](https://pypi.org/project/wavebox/)
[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-Donate-orange.svg)](https://www.buymeacoffee.com/wavebox)
Welcome to **Wavebox** – your ultimate solution for creating clean, compact, and blazing-fast Flask backend applications with ease! Whether you're a seasoned developer or just starting with Flask, Wavebox empowers you to build web applications quickly and efficiently.
## Features
- **Simplicity**: Wavebox is designed to make Flask backend development a breeze. Its clean and intuitive API lets you focus on your application's logic rather than boilerplate code.
- **Compact**: We believe in minimalism. With Wavebox, you get a lightweight package that doesn't bloat your project. It keeps your codebase neat and tidy.
- **Ease of Use**: Whether you're a beginner or a pro, Wavebox is easy to pick up. Our documentation is comprehensive and user-friendly, helping you get started in no time.
## Installation
Install Wavebox using pip:
```bash
pip install wavebox
```
## Quick Start
Getting started with Wavebox is as easy as 1-2-3! Here's a quick example of setting up a basic Flask app:
### Main
```python
from flask import Flask, Blueprint, Response, jsonify
from werkzeug.exceptions import NotFound, BadRequest
from wavebox.definitions import Applications
from wavebox.components.exceptions import FundamentalException
class ApplicationName(Applications):
def __init__(self, flask_app: Flask):
super().__init__(flask_app, Blueprint('root', flask_app.name, url_prefix="/"))
def global_handle_http_exception(self, ex: FundamentalException) -> Response:
pass
def main():
app = Flask(__name__)
application_name = ApplicationName(app)
application_name.start()
if __name__ == '__main__':
main()
```
Save this as `app.py`, and you're ready to go! Run your app with `python app.py`, and visit `http://localhost:5000` in your browser to see it in action.
## Documentation
For detailed information on using Wavebox, check out our [documentation](https://github.com/xoxoist/dicksy/wiki).
## Contributing
We welcome contributions from the community! If you have ideas, bug reports, or want to contribute to Wavebox, please see our [Contribution Guidelines](CONTRIBUTING.md).
## License
Wavebox is distributed under the [GNU General Public License](LICENSE).
## Get Started Now
Wavebox is here to simplify your Flask backend development. Start building web applications the clean, compact, fast, and easy way with Wavebox!
if you have ideas, bug reports, or want to contribute to Wavebox, please see our [Contribution Guidelines](CONTRIBUTING.md).
Happy coding with Wavebox! 🚀🌊
Raw data
{
"_id": null,
"home_page": "",
"name": "wavebox",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "backend,performance,error handling,wrapper,development",
"author": "",
"author_email": "Nightsilver Tech <hyperspace018@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a6/8a/dcfa840df57e542b9ecde48adbef0b832b9333367123e75f8e99913f59da/wavebox-1.0.1.tar.gz",
"platform": null,
"description": "# Wavebox: Clean, Compact, and Easy Flask Backend Wrapper\n\n[![PyPI Version](https://img.shields.io/pypi/v/wavebox.svg)](https://pypi.org/project/wavebox/)\n[![Python Versions](https://img.shields.io/pypi/pyversions/wavebox.svg)](https://pypi.org/project/wavebox/)\n[![License](https://img.shields.io/pypi/l/wavebox.svg)](https://pypi.org/project/wavebox/)\n\n[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-Donate-orange.svg)](https://www.buymeacoffee.com/wavebox)\n\nWelcome to **Wavebox** \u2013 your ultimate solution for creating clean, compact, and blazing-fast Flask backend applications with ease! Whether you're a seasoned developer or just starting with Flask, Wavebox empowers you to build web applications quickly and efficiently.\n\n## Features\n\n- **Simplicity**: Wavebox is designed to make Flask backend development a breeze. Its clean and intuitive API lets you focus on your application's logic rather than boilerplate code.\n\n- **Compact**: We believe in minimalism. With Wavebox, you get a lightweight package that doesn't bloat your project. It keeps your codebase neat and tidy.\n\n- **Ease of Use**: Whether you're a beginner or a pro, Wavebox is easy to pick up. Our documentation is comprehensive and user-friendly, helping you get started in no time.\n\n## Installation\n\nInstall Wavebox using pip:\n\n```bash\npip install wavebox\n```\n\n## Quick Start\n\nGetting started with Wavebox is as easy as 1-2-3! Here's a quick example of setting up a basic Flask app:\n\n### Main\n```python\nfrom flask import Flask, Blueprint, Response, jsonify\nfrom werkzeug.exceptions import NotFound, BadRequest\nfrom wavebox.definitions import Applications\nfrom wavebox.components.exceptions import FundamentalException\n\nclass ApplicationName(Applications):\n\n def __init__(self, flask_app: Flask):\n super().__init__(flask_app, Blueprint('root', flask_app.name, url_prefix=\"/\"))\n\n def global_handle_http_exception(self, ex: FundamentalException) -> Response:\n pass\n\ndef main():\n app = Flask(__name__)\n application_name = ApplicationName(app)\n application_name.start()\n\nif __name__ == '__main__':\n main()\n```\n\nSave this as `app.py`, and you're ready to go! Run your app with `python app.py`, and visit `http://localhost:5000` in your browser to see it in action.\n\n## Documentation\n\nFor detailed information on using Wavebox, check out our [documentation](https://github.com/xoxoist/dicksy/wiki).\n\n## Contributing\n\nWe welcome contributions from the community! If you have ideas, bug reports, or want to contribute to Wavebox, please see our [Contribution Guidelines](CONTRIBUTING.md).\n\n## License\n\nWavebox is distributed under the [GNU General Public License](LICENSE).\n\n## Get Started Now\n\nWavebox is here to simplify your Flask backend development. Start building web applications the clean, compact, fast, and easy way with Wavebox!\n\nif you have ideas, bug reports, or want to contribute to Wavebox, please see our [Contribution Guidelines](CONTRIBUTING.md).\n\nHappy coding with Wavebox! \ud83d\ude80\ud83c\udf0a\n",
"bugtrack_url": null,
"license": "",
"summary": "A compact, fast, and easy to use flask backend wrapper",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/xoxoist/dicksy/issues",
"Homepage": "https://github.com/xoxoist/dicksy",
"Repository": "https://github.com/xoxoist/dicksy"
},
"split_keywords": [
"backend",
"performance",
"error handling",
"wrapper",
"development"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f5db9608cb277fd578321eb53802deabfff6f55aa55f6ef5d13e312413ef101f",
"md5": "2bb3e560594751891fb965aff7f090d0",
"sha256": "99227384ca26984340300e734eb0c53a12efb5a3fa6e61e17876866904d3548a"
},
"downloads": -1,
"filename": "wavebox-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2bb3e560594751891fb965aff7f090d0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 22433,
"upload_time": "2023-10-05T11:39:52",
"upload_time_iso_8601": "2023-10-05T11:39:52.521545Z",
"url": "https://files.pythonhosted.org/packages/f5/db/9608cb277fd578321eb53802deabfff6f55aa55f6ef5d13e312413ef101f/wavebox-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a68adcfa840df57e542b9ecde48adbef0b832b9333367123e75f8e99913f59da",
"md5": "4993d3283e56ae26a8bbfcf6ea3ec35f",
"sha256": "8555b13a827c6d7a54f230cfc077ce3112bdd8c60f813e35dd352a270b2063d4"
},
"downloads": -1,
"filename": "wavebox-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "4993d3283e56ae26a8bbfcf6ea3ec35f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 21755,
"upload_time": "2023-10-05T11:39:57",
"upload_time_iso_8601": "2023-10-05T11:39:57.092210Z",
"url": "https://files.pythonhosted.org/packages/a6/8a/dcfa840df57e542b9ecde48adbef0b832b9333367123e75f8e99913f59da/wavebox-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-05 11:39:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xoxoist",
"github_project": "dicksy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "wavebox"
}