# **Advisory**
**This library is an experimental project porting the original PyMISP project to python async to address I/O bound processing difficulties often encountered when using large MISP instances.**
**It is an ALPHA release, this code has not been tested, USE AT YOUR OWN RISK!**
# PyMISP - Python Library to access MISP
PyMISP is a Python library to access [MISP](https://github.com/MISP/MISP) platforms via their REST API.
PyMISP allows you to fetch events, add or update events/attributes, add or update samples or search for attributes.
This project aims at porting the original PyMISP project to Python async using the `aiohttp` library instead of the synchronous `requests` library.
## Install from pip
**It is strongly recommended to use a virtual environment**
If you want to know more about virtual environments, [python has you covered](https://docs.python.org/3/tutorial/venv.html)
Only basic dependencies:
```
pip3 install pymisp-async
```
## Install the latest version from repo from development purposes
**Note**: poetry is required; e.g., "pip3 install poetry"
```
git clone https://github.com/pixmaip/PyMISP-async.git && cd PyMISP-async
git submodule update --init
poetry install
```
## Usage
Initialize the `PyMISP` object using the asynchronous context manager:
```
async with PyMISP(url, key) as misp_obj:
events = await misp_obj.events()
```
## Documentation
The official MISP documentation is available [here](https://pymisp.readthedocs.io/en/latest/).
All `async` functions present in this library use the same API as the original MISP package.
# License
PyMISP is distributed under an [open source license](./LICENSE). A simplified 2-BSD license.
Raw data
{
"_id": null,
"home_page": "https://github.com/MISP/PyMISP",
"name": "pymisp-async",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Rapha\u00ebl Vinot",
"author_email": "raphael.vinot@circl.lu",
"download_url": "https://files.pythonhosted.org/packages/ba/40/fb287ed66d83b06503dd9c9bd2bd71d99f873442e84b12f18f0a3fb4cf08/pymisp_async-2.4.182a3.tar.gz",
"platform": null,
"description": "# **Advisory**\n\n**This library is an experimental project porting the original PyMISP project to python async to address I/O bound processing difficulties often encountered when using large MISP instances.**\n\n**It is an ALPHA release, this code has not been tested, USE AT YOUR OWN RISK!**\n\n# PyMISP - Python Library to access MISP\n\nPyMISP is a Python library to access [MISP](https://github.com/MISP/MISP) platforms via their REST API.\n\nPyMISP allows you to fetch events, add or update events/attributes, add or update samples or search for attributes.\n\nThis project aims at porting the original PyMISP project to Python async using the `aiohttp` library instead of the synchronous `requests` library.\n\n## Install from pip\n\n**It is strongly recommended to use a virtual environment**\n\nIf you want to know more about virtual environments, [python has you covered](https://docs.python.org/3/tutorial/venv.html)\n\nOnly basic dependencies:\n```\npip3 install pymisp-async\n```\n\n## Install the latest version from repo from development purposes\n\n**Note**: poetry is required; e.g., \"pip3 install poetry\"\n\n```\ngit clone https://github.com/pixmaip/PyMISP-async.git && cd PyMISP-async\ngit submodule update --init\npoetry install\n```\n\n## Usage\n\nInitialize the `PyMISP` object using the asynchronous context manager:\n```\nasync with PyMISP(url, key) as misp_obj:\n events = await misp_obj.events()\n```\n\n## Documentation\n\nThe official MISP documentation is available [here](https://pymisp.readthedocs.io/en/latest/).\n\nAll `async` functions present in this library use the same API as the original MISP package.\n\n# License\n\nPyMISP is distributed under an [open source license](./LICENSE). A simplified 2-BSD license.\n\n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "Python async API for MISP.",
"version": "2.4.182a3",
"project_urls": {
"Bug Tracker": "https://github.com/MISP/PyMISP/issues",
"Documentation": "https://pymisp.readthedocs.io",
"Homepage": "https://github.com/MISP/PyMISP",
"Repository": "https://github.com/MISP/PyMISP",
"Source": "https://github.com/MISP/PyMISP"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7151950c9284f6bb4d9cecf166c007fbb374f6723cf1f8238b8eea4017d38edf",
"md5": "dcc171d9b132b159c6c6fe84eb733eb2",
"sha256": "9968735fa17a5cae2aa408a8d2e2f674babecd7ef56253ab7dd34b720405d31d"
},
"downloads": -1,
"filename": "pymisp_async-2.4.182a3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dcc171d9b132b159c6c6fe84eb733eb2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 158847,
"upload_time": "2023-12-29T10:01:06",
"upload_time_iso_8601": "2023-12-29T10:01:06.222130Z",
"url": "https://files.pythonhosted.org/packages/71/51/950c9284f6bb4d9cecf166c007fbb374f6723cf1f8238b8eea4017d38edf/pymisp_async-2.4.182a3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba40fb287ed66d83b06503dd9c9bd2bd71d99f873442e84b12f18f0a3fb4cf08",
"md5": "1e276c723b316efa77fcff5ae70af904",
"sha256": "0a7adc6eeb17e729fbe95b111236d728d4c3c5bd10826d25a101bbce254af84c"
},
"downloads": -1,
"filename": "pymisp_async-2.4.182a3.tar.gz",
"has_sig": false,
"md5_digest": "1e276c723b316efa77fcff5ae70af904",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 143929,
"upload_time": "2023-12-29T10:01:09",
"upload_time_iso_8601": "2023-12-29T10:01:09.212712Z",
"url": "https://files.pythonhosted.org/packages/ba/40/fb287ed66d83b06503dd9c9bd2bd71d99f873442e84b12f18f0a3fb4cf08/pymisp_async-2.4.182a3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-29 10:01:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MISP",
"github_project": "PyMISP",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pymisp-async"
}
JSON
