feat: Initial commit

[hcymerys]

This pull request introduces significant updates to the repository, including new GitHub Actions workflows, documentation enhancements, and the addition of example files and core module initialization for the mfd-cli-client. The changes aim to streamline CI/CD processes, improve code scanning, and provide better documentation and examples for developers.

CI/CD Enhancements:

• .github/workflows/build_upload_whl.yml: Added a reusable workflow for building and uploading .whl Python packages, including support for version bumping, virtual environment setup, and test execution.
• .github/workflows/manual_release.yml: Introduced a manual release workflow that supports matrix builds for different Python versions and handles package uploads and tagging.
• .github/workflows/pull_requests.yml: Added a development build workflow triggered by pull requests, focusing on testing and building .whl files for evaluation purposes.
• .github/workflows/codeql.yml: Implemented an advanced CodeQL workflow for security scanning across supported languages, including Python and GitHub Actions.

Documentation Updates:

• README.md: Added comprehensive documentation for the mfd-cli-client, including usage examples, implemented methods, data structures, and supported OS details.
• AUTHORS.md: Created an authors file listing contributors to the project.
• CONTRIBUTING.md: Updated the license reference to align with the new LICENSE.md file.
• LICENSE.md: Added the MIT license, granting permissions for software usage, modification, and distribution.

Code Examples:

• examples/cli_client_example.py: Added an example script demonstrating the usage of the mfd-cli-client module, including methods for retrieving switch stats, VSI stats, and VSI list entries.

Core Module Initialization:

• mfd_cli_client/__init__.py: Initialized the main module by importing key classes and structures such as CliClient, FlowStats, TrafficClassCounters, and SwitchStats.

[mfd-intel-bot]

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-cli-client@first_release'

[mfd-intel-bot]

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-cli-client@first_release'

[github-advanced-security]

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

[Copilot]

Pull Request Overview

This initial commit introduces the mfd-cli-client package, providing a command-line interface client for Intel® IPU Control Plane, complete with core implementation, unit tests, documentation, and CI/CD configuration.

• Added CliClient implementation and associated data structures in mfd_cli_client/base.py
• Added comprehensive unit tests under tests/unit/test_mfd_cli_client/
• Added Sphinx documentation skeleton and generation script; CI/CD workflows; packaging and metadata files

Reviewed Changes

Copilot reviewed 28 out of 31 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
mfd_cli_client/base.py	Implements CliClient, command execution, and parsing
mfd_cli_client/exceptions.py	Defines module-specific exceptions
tests/unit/test_mfd_cli_client/test_base.py	Comprehensive unit tests for CliClient methods
examples/cli_client_example.py	Example usage script showing how to use CliClient
sphinx-doc/generate_docs.py	Sphinx docs generation script
sphinx-doc/index.rst	Initial documentation index
README.md	Project overview, usage examples, and API reference
pyproject.toml	Packaging and dependency configuration
requirements-*.txt	Dependency definitions for runtime, docs, tests, dev
.github/workflows/	CI/CD pipeline definitions
LICENSE.md, AUTHORS.md, CONTRIBUTING.md	Licensing and contributor information

Comments suppressed due to low confidence (3)

requirements-test.txt:1

• This references requirements.txt which is not present in the repository; either add the file or update the reference to the correct path.

-r requirements.txt

tests/unit/test_mfd_cli_client/test_base.py:444

• [nitpick] The test calls apply_up_tc_changes but does not assert that the underlying execute_cli_client_command was invoked with the expected command; consider adding that assertion.

        cli_client.apply_up_tc_changes("file")

[mfd-intel-bot]

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-cli-client@first_release'

[mfd-intel-bot]

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-cli-client@first_release'