feat: eos_downloader v2 #103
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…lBase with offline XML
titom73
added
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes several changes to the
eos_downloaderproject, focusing on improving the overall code structure, CLI commands, updating the documentation, and cleaning up the codebase.Important
This Pull Request is introducing breaking change and compatibility with previous version is not maintained.
One of the main goal is to make code easier to maintain and open the door to easily support extension of software to download from Arista website. Today it is limited to EOS and CloudVision.
Task list:
Available commands
ardl get eos ...ardl get cvp ...ardl info latestardl info versionsardl info mappingardl debug xmlChanges
Codebase simplification
In this pull request, codebase has been massively updated in a more granular way:
models: all data representation mostly based on Pydantic.logics: classes that implement logics to manipulate data.helpers: Some functions to make code easier to maintain.Full OOP approach to make it easier to maintain:
Data modeling with following objects:
eos_downloader.models.versions.{woftware}Version: A SemVer representation of a version. Helpful to do comparisons.eos_downloader.models.data.DataMapping: Structure to save file structure.Code logic is part of the following objects:
eos_downloader.logics.server.AristaServer: Manage HTTPS connection with Arista servereos_downloader.logics.arista_server.AristaXmlQuerier: To query data from Arista website to get version information.eos_downloader.logics.arista_server.{software}XmlObject: Object that represents a file to download from Arista Websiteeos_downloader.logics.download.SoftManager: A class to manage object download from Arista website.CLI Commands Enhancements:
infocommand to list information from the Arista website (README.md, README.mdR45-R155).versionsandlatestcommands to list available versions and get the latest version of Arista packages (eos_downloader/cli/cli.py, eos_downloader/cli/cli.pyL65-R69).Documentation Updates:
README.mdto include new commands and improve the clarity of existing instructions (README.md, [1] [2].