Skip to content

About

Rust-based utilities for PyAVD

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

367 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

Schema compilation and source-code generation are distributed separately as pyavd-utils-gen. The generation package pins the matching pyavd-utils release and is only needed by AVD's development and build tooling; pyAVD runtime installations do not need it.


Both pyavd-utils and pyavd-utils-gen require Python 3.11 or later.

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.

Merge queue

Once the merge queue is enabled for main, maintainers can enqueue a pull request after its required reviews and checks pass. The queue runs required-checks and Autofix - run pre-commit on a temporary commit containing the latest main and preceding queued changes. Successful pull request checks do not replace this validation, and contributors do not need to update their branch just because main advances.

If a pull request leaves the queue because validation fails, inspect the failed run, fix the cause, and enqueue it again after its checks pass. Pre-commit failures block the queue run; autofix commits are only submitted outside merge-group runs. Avoid routinely jumping to the front of the queue, because reordering rebuilds the entries behind it.

License

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

About

Rust-based utilities for PyAVD

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages