# Flask-Aerospike
[](https://badge.fury.io/py/flask-aerospike)
[](https://github.com/flask/flask-aerospike/actions/workflows/test.yml)
[](https://flask-aerospike.readthedocs.io/en/latest/?badge=latest)
[](https://codeclimate.com/github/idoshr/flask-aerospike/maintainability)
[](https://codeclimate.com/github/idoshr/flask-aerospike/test_coverage)
## Overview
Flask-Aerospike is a Flask extension that provides integration with the Aerospike database.
It simplifies the process of connecting to and interacting with Aerospike from your
Flask applications.
## Installation
You can install Flask-Aerospike using pip:
```sh
pip install flask-aerospike
```
## Usage
Here is a simple example of how to use Flask-Aerospike in your Flask application:
```python
import aerospike
from flask import Flask
from flask_aerospike import FlaskAerospike
app = Flask(__name__)
app.config['FLASK_AEROSPIKE_CLIENT'] = aerospike.client({'hosts': [('127.0.0.1', 3000)]}).connect()
ap = FlaskAerospike(app)
@app.route('/')
def index():
client = ap.connection
# Your Aerospike operations here
return 'Hello, Aerospike!'
if __name__ == '__main__':
app.run()
```
## Configuration
You can configure Flask-Aerospike using the following configuration variables:
- `FLASK_AEROSPIKE_CLIENT`: A list of tuples containing the host and port
of your Aerospike nodes.
- `SESSION_AEROSPIKE_NAMESPACE`: The namespace to use in Aerospike.
- `SESSION_AEROSPIKE_BIND_KEY`: The set to use in Aerospike.
## Documentation
The full documentation is available at [Read the Docs](https://flask-aerospike.readthedocs.io/en/latest/).
## Contributing
Contributions are welcome! Please read the [contributing guidelines](CONTRIBUTING.md)
for more information.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Credits
This project is maintained by:
- Ido Shraga
See the [AUTHORS.md](AUTHORS.md) file for a full list of contributors.
Raw data
{
"_id": null,
"home_page": null,
"name": "flask-aerospike",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Ido Shraga <idoshraga@gmail.com>",
"keywords": "flask, forms, aerospike, extension",
"author": null,
"author_email": "Ido Shraga <idoshraga@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/91/85/12970c0ffa882584aae0182021a876324fd79b0ad2846c530378a978053a/flask_aerospike-0.0.1.tar.gz",
"platform": "any",
"description": "# Flask-Aerospike\n\n[](https://badge.fury.io/py/flask-aerospike)\n[](https://github.com/flask/flask-aerospike/actions/workflows/test.yml)\n[](https://flask-aerospike.readthedocs.io/en/latest/?badge=latest)\n[](https://codeclimate.com/github/idoshr/flask-aerospike/maintainability)\n[](https://codeclimate.com/github/idoshr/flask-aerospike/test_coverage)\n\n\n## Overview\n\nFlask-Aerospike is a Flask extension that provides integration with the Aerospike database.\nIt simplifies the process of connecting to and interacting with Aerospike from your\nFlask applications.\n\n## Installation\n\nYou can install Flask-Aerospike using pip:\n\n```sh\npip install flask-aerospike\n```\n\n## Usage\n\nHere is a simple example of how to use Flask-Aerospike in your Flask application:\n\n```python\nimport aerospike\nfrom flask import Flask\nfrom flask_aerospike import FlaskAerospike\n\napp = Flask(__name__)\napp.config['FLASK_AEROSPIKE_CLIENT'] = aerospike.client({'hosts': [('127.0.0.1', 3000)]}).connect()\n\n\nap = FlaskAerospike(app)\n\n@app.route('/')\ndef index():\n client = ap.connection\n # Your Aerospike operations here\n return 'Hello, Aerospike!'\n\nif __name__ == '__main__':\n app.run()\n```\n\n## Configuration\n\nYou can configure Flask-Aerospike using the following configuration variables:\n\n- `FLASK_AEROSPIKE_CLIENT`: A list of tuples containing the host and port\nof your Aerospike nodes.\n- `SESSION_AEROSPIKE_NAMESPACE`: The namespace to use in Aerospike.\n- `SESSION_AEROSPIKE_BIND_KEY`: The set to use in Aerospike.\n\n## Documentation\n\nThe full documentation is available at [Read the Docs](https://flask-aerospike.readthedocs.io/en/latest/).\n\n## Contributing\n\nContributions are welcome! Please read the [contributing guidelines](CONTRIBUTING.md)\nfor more information.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Credits\n\nThis project is maintained by:\n\n- Ido Shraga\n\nSee the [AUTHORS.md](AUTHORS.md) file for a full list of contributors.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "Flask extension that provides integration with Aerospike.",
"version": "0.0.1",
"project_urls": {
"Changelog": "https://github.com/idoshr/flask-aerospike/releases",
"Documentation": "https://flask-aerospike.readthedocs.io/en/latest/",
"Homepage": "https://github.com/idoshr/flask-aerospike",
"Repository": "https://github.com/idoshr/flask-aerospike"
},
"split_keywords": [
"flask",
" forms",
" aerospike",
" extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c4f93c1afbcad8ef39d69f088bbc852c27c7ee669df3812405ba94b33d8ea09b",
"md5": "1038eb5db84467eb1783d29349c01c16",
"sha256": "bf113f8f4a14334431d984bdfbd5a94340bd4db305f2ec911cc3a2ffe5271281"
},
"downloads": -1,
"filename": "flask_aerospike-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1038eb5db84467eb1783d29349c01c16",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6157,
"upload_time": "2024-08-12T14:07:50",
"upload_time_iso_8601": "2024-08-12T14:07:50.527581Z",
"url": "https://files.pythonhosted.org/packages/c4/f9/3c1afbcad8ef39d69f088bbc852c27c7ee669df3812405ba94b33d8ea09b/flask_aerospike-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "918512970c0ffa882584aae0182021a876324fd79b0ad2846c530378a978053a",
"md5": "53a5229831d4ce62e26a7d56a8cb9939",
"sha256": "d6e5086147b6b1656b7067d7a258ac53598beee5a3ec98e65505f9278aa784f5"
},
"downloads": -1,
"filename": "flask_aerospike-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "53a5229831d4ce62e26a7d56a8cb9939",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11053,
"upload_time": "2024-08-12T14:07:52",
"upload_time_iso_8601": "2024-08-12T14:07:52.221086Z",
"url": "https://files.pythonhosted.org/packages/91/85/12970c0ffa882584aae0182021a876324fd79b0ad2846c530378a978053a/flask_aerospike-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-12 14:07:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "idoshr",
"github_project": "flask-aerospike",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "flask-aerospike"
}
JSON
