Skip to content

Commit 3b4504d

Browse files
committed
Doc: Adjust README.md
1 parent 234a660 commit 3b4504d

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66

77
# `pyavd-utils` 🦀
88

9-
[![CI Status](https://img.shields.io/github/actions/workflow/status/ClausHolbechArista/pyavd-utils/pull-request-management.yml?branch=main)](https://github.com/ClausHolbechArista/pyavd-utils/actions?query=workflow%3Aci)
10-
[![SonarCloud Coverage](https://sonarcloud.io/api/project_badges/measure?project=ClausHolbechArista_pyavd-utils&metric=coverage)](https://sonarcloud.io/dashboard?id=ClausHolbechArista_pyavd-utils)
9+
[![CI Status](https://img.shields.io/github/actions/workflow/status/aristanetworks/pyavd-utils/pull-request-management.yml?branch=main)](https://github.com/aristanetworks/pyavd-utils/actions?query=workflow%3Aci)
10+
[![SonarCloud Coverage](https://sonarcloud.io/api/project_badges/measure?project=aristanetworks_pyavd-utils&metric=coverage)](https://sonarcloud.io/dashboard?id=aristanetworks_pyavd-utils)
1111
[![PyPI Downloads](https://img.shields.io/pypi/dm/pyavd-utils?label=PyPI%20Downloads)](https://pypi.org/project/pyavd-utils/)
1212
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/pyavd-utils)](https://pypi.org/project/pyavd-utils/)
13-
[![License](https://img.shields.io/github/license/ClausHolbechArista/pyavd-utils)](https://github.com/ClausHolbechArista/pyavd-utils/blob/main/LICENSE)
13+
[![License](https://img.shields.io/github/license/aristanetworks/pyavd-utils)](https://github.com/aristanetworks/pyavd-utils/blob/main/LICENSE)
1414

15-
***
15+
---
1616

1717
## Purpose
1818

@@ -22,7 +22,7 @@
2222

2323
This repository, `pyavd-utils`, provides functionalities to PyAVD, specifically handling the heavy lifting of data structure validation and manipulation with the speed and safety guarantees of **Rust**.
2424

25-
***
25+
---
2626

2727
## ⚠️ Internal Warning
2828

@@ -33,19 +33,19 @@ This package is an **internal dependency** designed solely for the use of the `p
3333
>
3434
> Changes in minor and patch versions may include breaking API changes without prior notice.
3535
36-
***
36+
---
3737

3838
## Key Features
3939

4040
This Rust library provides the fundamental, performance-critical components for:
4141

42-
* **Schema Validation:** Efficiently validating input variables against the defined AVD schemas, such as those used by `eos_designs` and `eos_cli_config_gen`.
43-
* **Type Coercion:** Handling automatic and reliable type conversion for variables during the validation process.
44-
* **Data Transformation:** Executing the complex logic required to generate intermediate data structures like **AVD Facts** and the device-specific **Structured Configuration**.
42+
- **Schema Validation:** Efficiently validating input variables against the defined AVD schemas, such as those used by `eos_designs` and `eos_cli_config_gen`.
43+
- **Type Coercion:** Handling automatic and reliable type conversion for variables during the validation process.
44+
- **Data Transformation:** Executing the complex logic required to generate intermediate data structures like **AVD Facts** and the device-specific **Structured Configuration**.
4545

4646
By offloading these intensive tasks to compiled Rust code, `pyavd-utils` ensures that PyAVD maintains high performance, making the core AVD logic fast and robust when integrated into custom automation tools.
4747

48-
***
48+
---
4949

5050
## Installation
5151

@@ -61,8 +61,8 @@ The package is built as a set of Python bindings for the Rust code using `setupt
6161

6262
We welcome contributions to the `pyavd-utils` project. As this is a performance-focused component, any contributions should include thorough testing and benchmarking to ensure stability and verify performance improvements.
6363

64-
Please refer to the main [AVD GitHub repository](https://github.com/ClausHolbechArista/avd) for general contribution guidelines.
64+
Please refer to the main [AVD GitHub repository](https://github.com/aristanetworks/avd) for general contribution guidelines.
6565

6666
## License
6767

68-
`pyavd-utils` is licensed under Apache2. See the [LICENSE](https://www.google.com/search?q=https://github.com/ClausHolbechArista/pyavd-utils/blob/main/LICENSE) file for details.
68+
`pyavd-utils` is licensed under Apache2. See the [LICENSE](https://www.google.com/search?q=https://github.com/aristanetworks/pyavd-utils/blob/main/LICENSE) file for details.

0 commit comments

Comments
 (0)