# Gufo SNMP
*The accelerated Python SNMP client library.*
[](https://pypi.python.org/pypi/gufo_snmp/)
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://github.com/charliermarsh/ruff)
---
**Documentation**: [https://docs.gufolabs.com/gufo_snmp/](https://docs.gufolabs.com/gufo_snmp/)
**Source Code**: [https://github.com/gufolabs/gufo_snmp/](https://github.com/gufolabs/gufo_snmp/)
---
*Gufo SNMP* is the accelerated Python SNMP client library supporting both async and synchronous mode.
It consists of a clean Python API for high-efficient BER parser
and socket IO, implemented in the
[Rust][Rust] language with [PyO3][PyO3] wrapper.
The querying of the single MIB key is a simple task:
``` py
from gufo.snmp import SnmpSession
async with SnmpSession(addr="127.0.0.1", community="public") as session:
r = await session.get("1.3.6.1.2.1.1.3.0")
```
And the blocking mode shares virtually the same API:
``` py
from gufo.snmp.sync_client import SnmpSession
with SnmpSession(addr="127.0.0.1", community="public") as session:
r = session.get("1.3.6.1.2.1.1.3.0")
```
Multiple keys can be queried by one request too:
``` py
async with SnmpSession(addr="127.0.0.1", community="public") as session:
r = await session.get_many(["1.3.6.1.2.1.1.3.0", "1.3.6.1.2.1.1.2.0"])
```
The querying of the MIB parts is also available with GetNext request:
``` py
async with SnmpSession(addr="127.0.0.1", community="public") as session:
async for oid, value in session.getnext("1.3.6.1.2.1.1"):
...
```
And with GetBulk request:
``` py
async with SnmpSession(addr="127.0.0.1", community="public") as session:
async for oid, value in session.getbulk("1.3.6.1.2.1.1"):
...
```
The `.fetch()` method allows to choose between `.getnext()` and `.getbulk()` automatically:
``` py
async with SnmpSession(addr="127.0.0.1", community="public") as session:
async for oid, value in session.fetch("1.3.6.1.2.1.1"):
...
```
SNMPv3 shares same API and semantics:
``` py
async with SnmpSession(
addr="127.0.0.1",
user=User(
"user1",
auth_key=Sha1Key(b"12345678"),
priv_key=Aes128Key(b"87654321")
)
) as session:
r = await session.get("1.3.6.1.2.1.1.3.0")
```
*Gufo SNMP* also allows to limit rate of outgoing requests to protect equipment
from overloading:
``` py
async with SnmpSession(addr="127.0.0.1", community="public", limit_rps=10) as session:
async for oid, value in session.fetch("1.3.6.1.2.1.1"):
...
```
*Gufo SNMP* offers various tools for developers, including a wrapper to
run a local instance of SNMP daemon:
``` py
async with Snmpd(), SnmpSession(addr="127.0.0.1", port=10161) as session:
r = await session.get("1.3.6.1.2.1.1.3.0")
```
## Features
* Clean async and blocking API.
* SNMP v1/v2c/v3 support.
* SNMP v3 User Security Model:
* Authentication: HMAC-MD5-96, HMAC-SHA-96.
* Privacy: DES, AES128.
* Engine ID discovery.
* High-performance.
* Built with security in mind.
* Zero-copy BER parsing.
* Query rate limiting.
* Full Python typing support.
* Editor completion.
* Well-tested, battle-proven code.
* Thoroughly check compatibility with various network equipment.
## Further Roadmap
* SHA2 family of hashes.
* AES256 encryption.
* SNMP Trap and Inform collector.
* Incorporation of the [NOC's][NOC] *Compiled MIB* infrastructure.
## On Gufo Stack
This product is a part of [Gufo Stack][Gufo Stack] - the collaborative effort
led by [Gufo Labs][Gufo Labs]. Our goal is to create a robust and flexible
set of tools to create network management software and automate
routine administration tasks.
To do this, we extract the key technologies that have proven themselves
in the [NOC][NOC] and bring them as separate packages. Then we work on API,
performance tuning, documentation, and testing. The [NOC][NOC] uses the final result
as the external dependencies.
[Gufo Stack][Gufo Stack] makes the [NOC][NOC] better, and this is our primary task. But other products
can benefit from [Gufo Stack][Gufo Stack] too. So we believe that our effort will make
the other network management products better.
[Gufo Labs]: https://gufolabs.com/
[Gufo Stack]: https://gufolabs.com/products/gufo-stack/
[NOC]: https://getnoc.com/
[Rust]: https://rust-lang.org/
[PyO3]: https://pyo3.rs/
Raw data
{
"_id": null,
"home_page": null,
"name": "gufo-snmp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "error",
"author": "Gufo Labs",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/16/4a/400dd9f4e9a3fbcf07853606ed831f09679531291e913241cac69c043a95/gufo_snmp-0.6.0.tar.gz",
"platform": null,
"description": "# Gufo SNMP\n\n*The accelerated Python SNMP client library.*\n\n[](https://pypi.python.org/pypi/gufo_snmp/)\n\n[](https://opensource.org/licenses/BSD-3-Clause)\n\n\n[](https://github.com/charliermarsh/ruff)\n\n---\n\n**Documentation**: [https://docs.gufolabs.com/gufo_snmp/](https://docs.gufolabs.com/gufo_snmp/)\n\n**Source Code**: [https://github.com/gufolabs/gufo_snmp/](https://github.com/gufolabs/gufo_snmp/)\n\n---\n\n*Gufo SNMP* is the accelerated Python SNMP client library supporting both async and synchronous mode.\nIt consists of a clean Python API for high-efficient BER parser\nand socket IO, implemented in the \n[Rust][Rust] language with [PyO3][PyO3] wrapper.\n\nThe querying of the single MIB key is a simple task:\n\n``` py\nfrom gufo.snmp import SnmpSession\n\nasync with SnmpSession(addr=\"127.0.0.1\", community=\"public\") as session:\n r = await session.get(\"1.3.6.1.2.1.1.3.0\")\n```\n\nAnd the blocking mode shares virtually the same API:\n\n``` py\nfrom gufo.snmp.sync_client import SnmpSession\n\nwith SnmpSession(addr=\"127.0.0.1\", community=\"public\") as session:\n r = session.get(\"1.3.6.1.2.1.1.3.0\")\n```\n\nMultiple keys can be queried by one request too:\n\n``` py\nasync with SnmpSession(addr=\"127.0.0.1\", community=\"public\") as session:\n r = await session.get_many([\"1.3.6.1.2.1.1.3.0\", \"1.3.6.1.2.1.1.2.0\"])\n```\n\nThe querying of the MIB parts is also available with GetNext request:\n\n``` py\nasync with SnmpSession(addr=\"127.0.0.1\", community=\"public\") as session:\n async for oid, value in session.getnext(\"1.3.6.1.2.1.1\"):\n ...\n```\n\nAnd with GetBulk request:\n\n``` py\nasync with SnmpSession(addr=\"127.0.0.1\", community=\"public\") as session:\n async for oid, value in session.getbulk(\"1.3.6.1.2.1.1\"):\n ...\n```\n\nThe `.fetch()` method allows to choose between `.getnext()` and `.getbulk()` automatically:\n``` py\nasync with SnmpSession(addr=\"127.0.0.1\", community=\"public\") as session:\n async for oid, value in session.fetch(\"1.3.6.1.2.1.1\"):\n ...\n```\n\nSNMPv3 shares same API and semantics:\n\n``` py\nasync with SnmpSession(\n addr=\"127.0.0.1\",\n user=User(\n \"user1\",\n auth_key=Sha1Key(b\"12345678\"),\n priv_key=Aes128Key(b\"87654321\")\n )\n) as session:\n r = await session.get(\"1.3.6.1.2.1.1.3.0\")\n```\n\n*Gufo SNMP* also allows to limit rate of outgoing requests to protect equipment\nfrom overloading:\n\n``` py\nasync with SnmpSession(addr=\"127.0.0.1\", community=\"public\", limit_rps=10) as session:\n async for oid, value in session.fetch(\"1.3.6.1.2.1.1\"):\n ...\n```\n\n\n*Gufo SNMP* offers various tools for developers, including a wrapper to\nrun a local instance of SNMP daemon:\n\n``` py\nasync with Snmpd(), SnmpSession(addr=\"127.0.0.1\", port=10161) as session:\n r = await session.get(\"1.3.6.1.2.1.1.3.0\")\n```\n\n## Features\n\n* Clean async and blocking API.\n* SNMP v1/v2c/v3 support.\n* SNMP v3 User Security Model:\n * Authentication: HMAC-MD5-96, HMAC-SHA-96.\n * Privacy: DES, AES128.\n * Engine ID discovery.\n* High-performance.\n* Built with security in mind.\n* Zero-copy BER parsing.\n* Query rate limiting.\n* Full Python typing support.\n* Editor completion.\n* Well-tested, battle-proven code.\n* Thoroughly check compatibility with various network equipment.\n\n## Further Roadmap\n\n* SHA2 family of hashes.\n* AES256 encryption.\n* SNMP Trap and Inform collector.\n* Incorporation of the [NOC's][NOC] *Compiled MIB* infrastructure.\n\n## On Gufo Stack\n\nThis product is a part of [Gufo Stack][Gufo Stack] - the collaborative effort \nled by [Gufo Labs][Gufo Labs]. Our goal is to create a robust and flexible \nset of tools to create network management software and automate \nroutine administration tasks.\n\nTo do this, we extract the key technologies that have proven themselves \nin the [NOC][NOC] and bring them as separate packages. Then we work on API,\nperformance tuning, documentation, and testing. The [NOC][NOC] uses the final result\nas the external dependencies.\n\n[Gufo Stack][Gufo Stack] makes the [NOC][NOC] better, and this is our primary task. But other products\ncan benefit from [Gufo Stack][Gufo Stack] too. So we believe that our effort will make \nthe other network management products better.\n\n[Gufo Labs]: https://gufolabs.com/\n[Gufo Stack]: https://gufolabs.com/products/gufo-stack/\n[NOC]: https://getnoc.com/\n[Rust]: https://rust-lang.org/\n[PyO3]: https://pyo3.rs/\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": null,
"version": "0.6.0",
"project_urls": {
"Bug Tracker": "https://github.com/gufolabs/gufo_snmp/issues",
"Changelog": "https://github.com/gufolabs/gufo_snmp/blob/master/CHANGELOG.md",
"Documentation": "https://docs.gufolabs.com/gufo_snmp/",
"Homepage": "https://github.com/gufolabs/gufo_snmp/",
"Source Code": "https://github.com/gufolabs/gufo_snmp/"
},
"split_keywords": [
"error"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7507b37ee0b76dda9c41d79aedef7b6de2406849d278fbf100f1cf331ed0b54c",
"md5": "e4f79eb581a275b72d8b44f63c2efe0b",
"sha256": "6686e755d5a101b2df3b8fb4e56ae460ae234ac25afd20c3233fbbeb747d1dab"
},
"downloads": -1,
"filename": "gufo_snmp-0.6.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "e4f79eb581a275b72d8b44f63c2efe0b",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.9",
"size": 407082,
"upload_time": "2024-11-07T11:06:57",
"upload_time_iso_8601": "2024-11-07T11:06:57.239437Z",
"url": "https://files.pythonhosted.org/packages/75/07/b37ee0b76dda9c41d79aedef7b6de2406849d278fbf100f1cf331ed0b54c/gufo_snmp-0.6.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c6c781ee75ec212e3854d4a3feb3e78261af2e3946b375d323a6a206a1f69c9a",
"md5": "54fdbdcaf91bc19765c5c9a5935cb0ec",
"sha256": "ee11895fc15cd2fc70f2e6225d577f6aeafd59983148da265b753e1f57213bdf"
},
"downloads": -1,
"filename": "gufo_snmp-0.6.0-cp310-cp310-manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "54fdbdcaf91bc19765c5c9a5935cb0ec",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.9",
"size": 407372,
"upload_time": "2024-11-07T11:06:58",
"upload_time_iso_8601": "2024-11-07T11:06:58.329681Z",
"url": "https://files.pythonhosted.org/packages/c6/c7/81ee75ec212e3854d4a3feb3e78261af2e3946b375d323a6a206a1f69c9a/gufo_snmp-0.6.0-cp310-cp310-manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "05edb7e30f85e70729a5dccc984a6544fa705a28fa7a9580bb9275e725ad4ceb",
"md5": "41d3a59ade03d208fc423972bdc22e4a",
"sha256": "12ade4620a862ad77d26d0f45b2234a9bda4f57f62b09d4ab0c6c00188f60fc1"
},
"downloads": -1,
"filename": "gufo_snmp-0.6.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "41d3a59ade03d208fc423972bdc22e4a",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.9",
"size": 406813,
"upload_time": "2024-11-07T11:06:59",
"upload_time_iso_8601": "2024-11-07T11:06:59.824251Z",
"url": "https://files.pythonhosted.org/packages/05/ed/b7e30f85e70729a5dccc984a6544fa705a28fa7a9580bb9275e725ad4ceb/gufo_snmp-0.6.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "602022c68c8b13a4edf9f011c8dbceffd2611860541105fd173a5b0f7841ca77",
"md5": "ad9a9d54f813ac16f7266c03f88e4820",
"sha256": "98e9ae8a17f55ca2252e26db6b82be51a4387b18e64aed51d7c62fce3b96f67f"
},
"downloads": -1,
"filename": "gufo_snmp-0.6.0-cp311-cp311-manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "ad9a9d54f813ac16f7266c03f88e4820",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.9",
"size": 407092,
"upload_time": "2024-11-07T11:07:00",
"upload_time_iso_8601": "2024-11-07T11:07:00.887436Z",
"url": "https://files.pythonhosted.org/packages/60/20/22c68c8b13a4edf9f011c8dbceffd2611860541105fd173a5b0f7841ca77/gufo_snmp-0.6.0-cp311-cp311-manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c751c0ed3d8f0f283ac7f41a6171f5feabd3fa94bc3b810bb774c4ea76bdde2c",
"md5": "46b503e3ccf9413934cfc75e45a5d2f5",
"sha256": "7a724e9be3ba7f5a089142a253701f5583fa01aec402203d41782bf19554b3df"
},
"downloads": -1,
"filename": "gufo_snmp-0.6.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "46b503e3ccf9413934cfc75e45a5d2f5",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.9",
"size": 407089,
"upload_time": "2024-11-07T11:07:02",
"upload_time_iso_8601": "2024-11-07T11:07:02.564399Z",
"url": "https://files.pythonhosted.org/packages/c7/51/c0ed3d8f0f283ac7f41a6171f5feabd3fa94bc3b810bb774c4ea76bdde2c/gufo_snmp-0.6.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cfef900953b99c2bd86dbaf3ef35397bbeab40c628cd9ded08cae0b7f5029845",
"md5": "86c234cd0a446af722cbd090e7762d69",
"sha256": "441b6e37d490f96598f5f3d54bd6f86258e768aefe6c98bc1db75003397f56b9"
},
"downloads": -1,
"filename": "gufo_snmp-0.6.0-cp312-cp312-manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "86c234cd0a446af722cbd090e7762d69",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.9",
"size": 407377,
"upload_time": "2024-11-07T11:07:04",
"upload_time_iso_8601": "2024-11-07T11:07:04.170883Z",
"url": "https://files.pythonhosted.org/packages/cf/ef/900953b99c2bd86dbaf3ef35397bbeab40c628cd9ded08cae0b7f5029845/gufo_snmp-0.6.0-cp312-cp312-manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1188481004ec0c848b31b67b731c99c18209e37db4f129fde7609bc51f6f9650",
"md5": "83d2e869a78f2524c0679e8ca381d3ba",
"sha256": "d835b2a994ac6ec30058ad154f3e3bd790bcf75ac7ca1357ffd14461280f4664"
},
"downloads": -1,
"filename": "gufo_snmp-0.6.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "83d2e869a78f2524c0679e8ca381d3ba",
"packagetype": "bdist_wheel",
"python_version": "cp313",
"requires_python": ">=3.9",
"size": 406837,
"upload_time": "2024-11-07T11:07:05",
"upload_time_iso_8601": "2024-11-07T11:07:05.581070Z",
"url": "https://files.pythonhosted.org/packages/11/88/481004ec0c848b31b67b731c99c18209e37db4f129fde7609bc51f6f9650/gufo_snmp-0.6.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fdcd0942660f60f3bcb8d467d859b229cf4d637bbf2f2914702bb8e76cb18917",
"md5": "46b7f32d6085cb357c43fbf1cc6f8ba7",
"sha256": "90d6b5ecdebb849e7b5d3ac2e075a070669b603895d1d2d10c6be0cd68ff3238"
},
"downloads": -1,
"filename": "gufo_snmp-0.6.0-cp313-cp313-manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "46b7f32d6085cb357c43fbf1cc6f8ba7",
"packagetype": "bdist_wheel",
"python_version": "cp313",
"requires_python": ">=3.9",
"size": 407117,
"upload_time": "2024-11-07T11:07:07",
"upload_time_iso_8601": "2024-11-07T11:07:07.259669Z",
"url": "https://files.pythonhosted.org/packages/fd/cd/0942660f60f3bcb8d467d859b229cf4d637bbf2f2914702bb8e76cb18917/gufo_snmp-0.6.0-cp313-cp313-manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3877c8daebc5b2c215c95f1b31f9c289c9f356f824599c0ae2cc3d478facf4e1",
"md5": "ebc8897a6b9ae7b8c1cf2ddeb559effb",
"sha256": "5e622ffbda56a49ea47d90590cec13a4be7a1b78982381ea5b82d82ff6bda28a"
},
"downloads": -1,
"filename": "gufo_snmp-0.6.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "ebc8897a6b9ae7b8c1cf2ddeb559effb",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 407868,
"upload_time": "2024-11-07T11:07:08",
"upload_time_iso_8601": "2024-11-07T11:07:08.654570Z",
"url": "https://files.pythonhosted.org/packages/38/77/c8daebc5b2c215c95f1b31f9c289c9f356f824599c0ae2cc3d478facf4e1/gufo_snmp-0.6.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1a18bf85a7e6e4409926fdec81998284ac6b59558d2d213e9312f6a2552bd33b",
"md5": "455ab766f7f5e841ff8dd48c8c3008c6",
"sha256": "5eff176d200349001b434995041666abfa081854540bd119e0c052f41dc558b3"
},
"downloads": -1,
"filename": "gufo_snmp-0.6.0-cp39-cp39-manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "455ab766f7f5e841ff8dd48c8c3008c6",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 408347,
"upload_time": "2024-11-07T11:07:09",
"upload_time_iso_8601": "2024-11-07T11:07:09.841125Z",
"url": "https://files.pythonhosted.org/packages/1a/18/bf85a7e6e4409926fdec81998284ac6b59558d2d213e9312f6a2552bd33b/gufo_snmp-0.6.0-cp39-cp39-manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "164a400dd9f4e9a3fbcf07853606ed831f09679531291e913241cac69c043a95",
"md5": "8b87395e21c3a0b933559547ae7c24c9",
"sha256": "221178e13d8476080afa01676b4f2b01c95d403cd7185437f1d39933a8804b46"
},
"downloads": -1,
"filename": "gufo_snmp-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "8b87395e21c3a0b933559547ae7c24c9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 33301,
"upload_time": "2024-11-07T11:07:11",
"upload_time_iso_8601": "2024-11-07T11:07:11.227523Z",
"url": "https://files.pythonhosted.org/packages/16/4a/400dd9f4e9a3fbcf07853606ed831f09679531291e913241cac69c043a95/gufo_snmp-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-07 11:07:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gufolabs",
"github_project": "gufo_snmp",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gufo-snmp"
}
JSON
