| Name | netmikro JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | Netmikro is a simple library that provides an easy way to manage Mikrotik routers, simplifying configuration and monitoring tasks. |
| upload_time | 2024-02-01 21:48:00 |
| maintainer | |
| docs_url | None |
| author | Henrique Sebastião |
| requires_python | >=3.11,<4.0 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<img src="docs/assets/netmikro.svg" width="100">
# Netmikro
Netmikro is a simple library that provides an easy way to manage Mikrotik routers, simplifying configuration and monitoring tasks.
Everything works through an instance of the RouterOS class that creates an SSH connection with the device, think of the instantiated object as your own router, this object has [methods](api/RouterOS.md) to interact with your router, or you can Run custom commands directly in your router's terminal with the `cmd()` method.
Netmikro is on the shoulders of the [Netmiko](https://github.com/ktbyers/netmiko) project, responsible for creating a connection via SSH with the Mikrotik router.
> 📝 **Note:** I'm just a computer networking enthusiast and have experience with handling MIkrotik routers. All Netmikro features are being tested during development with a Mikrotik RB912UAG-5HPn router. The idea is to test it on other models as soon as possible.
---
**Documentation**: [https://netmikro.henriquesebastiao.com](https://netmikro.henriquesebastiao.com)
**Source Code**: [https://github.com/henriquesebastiao/netmikro](https://github.com/henriquesebastiao/netmikro)
---
## How to install
Netmikro is available on PyPi, so just use your preferred package manager:
``` {.bash .copy }
pip install netmikro
```
## Basic usage
You just need to create an instance of RouterOS to use Netmikro features:
```Python
from netmikro import RouterOS
router = RouterOS(
'192.168.3.3',
'user',
'password',
22,
)
router.cmd('/system identity print')
```
## License
This project is licensed under the terms of the [MIT license](LICENSE).
Raw data
{
"_id": null,
"home_page": "",
"name": "netmikro",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Henrique Sebasti\u00e3o",
"author_email": "contato@henriquesebastiao.com",
"download_url": "https://files.pythonhosted.org/packages/9a/30/ad96dce0aab1958ac860f22f9532fa49499ce29bf4173091d12b2f832c46/netmikro-0.1.0.tar.gz",
"platform": null,
"description": "<img src=\"docs/assets/netmikro.svg\" width=\"100\">\n\n# Netmikro\n\nNetmikro is a simple library that provides an easy way to manage Mikrotik routers, simplifying configuration and monitoring tasks.\n\nEverything works through an instance of the RouterOS class that creates an SSH connection with the device, think of the instantiated object as your own router, this object has [methods](api/RouterOS.md) to interact with your router, or you can Run custom commands directly in your router's terminal with the `cmd()` method.\n\nNetmikro is on the shoulders of the [Netmiko](https://github.com/ktbyers/netmiko) project, responsible for creating a connection via SSH with the Mikrotik router.\n\n> \ud83d\udcdd **Note:** I'm just a computer networking enthusiast and have experience with handling MIkrotik routers. All Netmikro features are being tested during development with a Mikrotik RB912UAG-5HPn router. The idea is to test it on other models as soon as possible.\n\n---\n\n**Documentation**: [https://netmikro.henriquesebastiao.com](https://netmikro.henriquesebastiao.com)\n\n**Source Code**: [https://github.com/henriquesebastiao/netmikro](https://github.com/henriquesebastiao/netmikro)\n\n---\n\n## How to install\n\nNetmikro is available on PyPi, so just use your preferred package manager:\n\n``` {.bash .copy }\npip install netmikro\n```\n\n## Basic usage\n\nYou just need to create an instance of RouterOS to use Netmikro features:\n\n```Python\nfrom netmikro import RouterOS\n\n\nrouter = RouterOS(\n '192.168.3.3',\n 'user',\n 'password',\n 22,\n)\n\nrouter.cmd('/system identity print')\n```\n\n## License\n\nThis project is licensed under the terms of the [MIT license](LICENSE).",
"bugtrack_url": null,
"license": "",
"summary": "Netmikro is a simple library that provides an easy way to manage Mikrotik routers, simplifying configuration and monitoring tasks.",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/henriquesebastiao/netmikro/issues",
"Documentation": "https://netmikro.henriquesebastiao.com",
"Homepage": "https://netmikro.henriquesebastiao.com",
"Repository": "https://github.com/henriquesebastiao/netmikro"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1e5feff3d155bbcc2a92b6194cd11f477056e15c78ed201946be065655fa85a6",
"md5": "e7c583a8caa2f63ef55e50823eed0d55",
"sha256": "cc816eb8cb2593cd18c232c76bbea484eded962241702aea95979917b48495ee"
},
"downloads": -1,
"filename": "netmikro-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e7c583a8caa2f63ef55e50823eed0d55",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 6973,
"upload_time": "2024-02-01T21:47:58",
"upload_time_iso_8601": "2024-02-01T21:47:58.527637Z",
"url": "https://files.pythonhosted.org/packages/1e/5f/eff3d155bbcc2a92b6194cd11f477056e15c78ed201946be065655fa85a6/netmikro-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9a30ad96dce0aab1958ac860f22f9532fa49499ce29bf4173091d12b2f832c46",
"md5": "266b002b9f0bf8c0814e5062ca014241",
"sha256": "4caff0f02adbf1daabc69d275be4119d9aa37b10b791fb81ae433c9558d35941"
},
"downloads": -1,
"filename": "netmikro-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "266b002b9f0bf8c0814e5062ca014241",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 6288,
"upload_time": "2024-02-01T21:48:00",
"upload_time_iso_8601": "2024-02-01T21:48:00.560422Z",
"url": "https://files.pythonhosted.org/packages/9a/30/ad96dce0aab1958ac860f22f9532fa49499ce29bf4173091d12b2f832c46/netmikro-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-01 21:48:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "henriquesebastiao",
"github_project": "netmikro",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "netmikro"
}
