netmikro

Manage your Mikrotik RouterOS with Python

https://github.com/henriquesebastiao/netmikro

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (17.0%) to scientific vocabulary

Keywords

mikrotik mikrotik-api mikrotik-routeros-script mikrotik-script netmikro router routerboard routerboard-api routeros routeros-api routeros-scripts ssh

Last synced: 6 months ago · JSON representation ·

Repository

Manage your Mikrotik RouterOS with Python

Basic Info

Host: GitHub
Owner: henriquesebastiao
License: mit
Language: Python
Default Branch: main
Homepage: https://netmikro.henriquesebastiao.com
Size: 733 KB

Statistics

Stars: 4
Watchers: 1
Forks: 0
Open Issues: 2
Releases: 1

Topics

mikrotik mikrotik-api mikrotik-routeros-script mikrotik-script netmikro router routerboard routerboard-api routeros routeros-api routeros-scripts ssh

Created over 2 years ago · Last pushed 7 months ago

Metadata Files

Readme Contributing License Citation Security

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 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 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

Source Code: https://github.com/henriquesebastiao/netmikro

Compatibility note

For now, Netmikro is only fully compatible with versions higher than v7 of RouterOS, some features may even work with previous versions, but their use is not encouraged at the moment. However, I will make this support for previous versions possible as soon as possible.

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.

Owner

Name: Henrique Sebastião
Login: henriquesebastiao
Kind: user
Location: Aripuanã, MT - Brazil

Website: henriquesebastiao.com
Repositories: 58
Profile: https://github.com/henriquesebastiao

Desenvolvedor back-end, técnico de redes, músico, entusiasta em hardware, radioamadorismo e segurança.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Netmikro
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Henrique Sebastião
    family-names: da Silva Rosa
    email: contato@henriquesebastiao.com
repository-code: 'https://github.com/henriquesebastiao/netmikro'
url: 'https://netmikro.henriquesebastiao.com'
abstract: >-
  Netmikro is a simple library that provides an easy way to
  manage Mikrotik routers, simplifying configuration and
  monitoring tasks.
keywords:
  - netmikro
  - netmiko
  - paramiko
  - mikrotik
license: MIT
commit: 0397196
version: 0.1.0
date-released: '2024-02-01'

GitHub Events

Total

Watch event: 1
Delete event: 3
Issue comment event: 1
Push event: 2
Pull request event: 8
Create event: 4

Last Year

Watch event: 1
Delete event: 3
Issue comment event: 1
Push event: 2
Pull request event: 8
Create event: 4

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 6
Total pull requests: 38
Average time to close issues: about 15 hours
Average time to close pull requests: 1 day
Total issue authors: 1
Total pull request authors: 1
Average comments per issue: 0.0
Average comments per pull request: 0.03
Merged pull requests: 37
Bot issues: 0
Bot pull requests: 38

Past Year

Issues: 6
Pull requests: 21
Average time to close issues: about 15 hours
Average time to close pull requests: 1 day
Issue authors: 1
Pull request authors: 1
Average comments per issue: 0.0
Average comments per pull request: 0.05
Merged pull requests: 20
Bot issues: 0
Bot pull requests: 21

View more stats

Top Authors

Issue Authors

henriquesebastiao (6)

Pull Request Authors

dependabot[bot] (73)

Top Labels

Issue Labels

enhancement (2) good first issue (1) refactor (1) bug (1)

Pull Request Labels

dependencies (73) python (63) github_actions (1)

Packages

Total packages: 1
Total downloads:
- pypi 17 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 1
Total maintainers: 1

pypi.org: netmikro