Skip to content

Commit 1ac9e4d

Browse files
authored
Update README.md
1 parent edc151e commit 1ac9e4d

File tree

1 file changed

+49
-20
lines changed

1 file changed

+49
-20
lines changed

README.md

Lines changed: 49 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# NetDriver
2+
<a name="top"></a>
23

34
[![Python](https://img.shields.io/badge/Python-3.12%2B-blue.svg)](https://www.python.org/)
45
[![Poetry](https://img.shields.io/badge/Poetry-1.8.3-60A5FA.svg)](https://python-poetry.org/)
@@ -10,34 +11,56 @@
1011
[![Release](https://img.shields.io/badge/release-v0.1.0-blue.svg)](https://github.com/PanMarkCake/REPO/releases/tag/v0.1.0)
1112
![Release Date](https://img.shields.io/badge/release--date-August_2025-blue.svg)
1213

14+
⭐ Star us on GitHub — your support motivates us a lot! 🙏😊
15+
16+
[![Share](https://img.shields.io/badge/share-000000?logo=x&logoColor=white)](https://x.com/intent/tweet?text=Check%20out%20this%20project%20on%20GitHub:%20https://github.com/Abblix/Oidc.Server%20%23OpenIDConnect%20%23Security%20%23Authentication)
17+
[![Share](https://img.shields.io/badge/share-1877F2?logo=facebook&logoColor=white)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/Abblix/Oidc.Server)
18+
[![Share](https://img.shields.io/badge/share-0A66C2?logo=linkedin&logoColor=white)](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/Abblix/Oidc.Server)
19+
[![Share](https://img.shields.io/badge/share-FF4500?logo=reddit&logoColor=white)](https://www.reddit.com/submit?title=Check%20out%20this%20project%20on%20GitHub:%20https://github.com/Abblix/Oidc.Server)
20+
[![Share](https://img.shields.io/badge/share-0088CC?logo=telegram&logoColor=white)](https://t.me/share/url?url=https://github.com/Abblix/Oidc.Server&text=Check%20out%20this%20project%20on%20GitHub)
1321

1422
# Table of Contents
15-
- [Overview](#overview)
16-
- [Features](#features)
17-
- [Installation](#installation)
23+
- [About](#about)
24+
- [Updates](#updates)
25+
- [Comparison](#comparison)
26+
- [Build](#Build)
1827
- [Usage](#usage)
19-
- [Contributing](#contributing)
28+
- [Contributions](#contributions)
2029
- [License](#license)
21-
- [Themes](#themes)
22-
23-
## Overview
24-
25-
NetDriver is a network device automation framework that enables CLI command execution through HTTP RESTful APIs. It simplifies network automation development while enhancing security and reliability.
30+
- [Contacts](#contacts)
2631

32+
## About
33+
Everyone loves netmiko cause it's the best at what it can do, so instead of reinventing the wheel we decided to add couple of sticks in to it by implementing some Quality-of-life features.
34+
NetDriver is a network device automation framework that enables CLI command execution through HTTP RESTful APIs.
35+
With features like session persistence for efficiency a command queue to avoid configuration conflicts and an HTTP RESTful API for simple third-party integration. With its plugin architecture which combines automation scalability and contemporary network management in a single framework it offers high concurrency and is built on top of AsyncSSH
36+
for your convinience.
2737

2838
NetDriver adopts a Monorepo architecture consisting of multiple sub-projects:
2939

3040
- **netdriver-agent** - Provides REST APIs for device connectivity testing and command execution
3141
- **netdriver-simunet** - Simulates network device terminals for automated testing and other scenarios requiring device emulation
3242

33-
34-
## Features
43+
Features:
3544

3645
- 🌐 **HTTP RESTful API** : Easy integration with third-party platforms
3746
- 🔄 **Session Management** : Customizable session persistence for improved efficiency, eliminating repeated connections per command
3847
- 📋 **Command Queue** : Ensures sequential command execution on devices, preventing configuration errors and failures caused by concurrent modifications
3948
-**AsyncSSH Foundation** : Superior concurrency capabilities through asynchronous SSH implementation
4049
- 🔌 **Plugin Architecture** : Simplified and accelerated development of new vendor support
50+
51+
## Comparison
52+
53+
| Feature | NetDriver | Netmiko |
54+
|------------|:--------:|:----:|
55+
| **HTTP RESTful API for third-party integration** |||
56+
| **Session persistence with customizable duration** |||
57+
| **Python-based implementation** |||
58+
| **Command execution queue to prevent concurrent conflicts** |||
59+
| **Plugin architecture for easier device support development** |||
60+
| **Standard CLI automation** |||
61+
| **Open source** |||
62+
| **AsyncSSH-based architecture for high concurrency** |||
63+
4164

4265

4366
## Project Structure
@@ -63,7 +86,9 @@ netdriver/
6386
└── pyproject.toml # Project metadata and dependencies
6487
```
6588

66-
## Installation
89+
## Build
90+
91+
Fallow this steps to build our package:
6792

6893
### Prerequisites
6994

@@ -74,7 +99,7 @@ netdriver/
7499

75100
### Python Installation
76101

77-
We recommend using pyenv to manage and install Python.
102+
Recommended using pyenv to manage and install Python.
78103

79104
Install Python build dependencies
80105

@@ -216,9 +241,10 @@ Run integration tests only:
216241
poetry run pytest -m integration
217242
```
218243

219-
## Contributing
244+
##🤝 Contributions and Requests
220245

221-
Contributions are welcome! Please feel free to submit a Pull Request.
246+
Your contributions matter!Our project can always be better so we would be happy to recive your help!Please take a look at [contributing](./CONTRIBUTING.md) guide before submiting a pull request!
247+
For questions, issues, or feature requests, please open an issue on the project repository.
222248

223249
### Development Guidelines
224250

@@ -229,18 +255,21 @@ Contributions are welcome! Please feel free to submit a Pull Request.
229255

230256
## Support
231257

232-
For questions, issues, or feature requests, please open an issue on the project repository.
233258

234-
# License
235259

236-
This project is licensed under the [Apache License 2.0](LICENSE).
260+
## 📃 License
237261

238-
## Themes
239-
asdasdas
262+
This project is licensed under the [Apache License 2.0](LICENSE).
240263

241264
## Authors
242265

243266
244267
245268
246269
270+
271+
## 🗨️ Contacts
272+
273+
We look forward to assisting you and ensuring your experience with our products is successful and enjoyable!
274+
275+
[Back to top](#top)

0 commit comments

Comments
 (0)