Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 2.59 KB

File metadata and controls

45 lines (29 loc) · 2.59 KB

pyavd-utils 🦀

CI Status SonarCloud Coverage PyPI Downloads Supported Python Versions License


⚠️ Danger

This package is an internal dependency designed solely for the use of the pyavd Python library. It exposes low-level functionality and is not intended for direct use by end-users.

Caution

Should not be used directly and may not follow semantic versioning.

Changes in minor and patch versions may include breaking API changes without prior notice.


Purpose

pyavd-utils provides functionalities in Rust for the Python package, PyAVD.

PyAVD is designed to expose the core logic of the AVD Ansible collection (arista.avd) as a standalone, dependency-lite Python library. This allows developers to utilize AVD's complex data processing capabilities—like input validation, AVD facts generation, and structured configuration generation—within custom Python applications without requiring a full Ansible installation or runtime.

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.


Contribution and Development

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.

Please refer to the main AVD GitHub repository for general contribution guidelines.

License

pyavd-utils is licensed under Apache2. See the LICENSE file for details.