-
Notifications
You must be signed in to change notification settings - Fork 0
feat: Initial commit #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
We don't publish DEVs .whl. |
1 similar comment
We don't publish DEVs .whl. |
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. |
Signed-off-by: Baczek, Arkadiusz <[email protected]>
We don't publish DEVs .whl. |
1 similar comment
We don't publish DEVs .whl. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Initial commit adding the core mfd_kernel_namespace
module, its tests, documentation, examples, and CI/packaging configuration.
- Introduces
add_namespace_call_command
for prefixing commands with network namespace support - Adds unit tests, Sphinx docs, usage example, and project metadata files
- Configures CI workflows for testing, building wheels, and CodeQL scanning
Reviewed Changes
Copilot reviewed 27 out of 30 changed files in this pull request and generated 2 comments.
Show a summary per file
File | Description |
---|---|
tests/unit/test_mfd_kernel_namespace/test_mfd_kernel_namespace.py | Adds unit tests for add_namespace_call_command . |
tests/unit/test_mfd_kernel_namespace/init.py | Initializes test namespace package with license. |
tests/unit/init.py | Initializes unit tests package with license. |
tests/init.py | Initializes tests root package with license. |
sphinx-doc/py-modindex.rst | Placeholder for module index. |
sphinx-doc/index.rst | Main Sphinx toctree setup. |
sphinx-doc/genindex.rst | Placeholder for general index. |
sphinx-doc/generate_docs.py | Script to auto-generate and build docs. |
sphinx-doc/conf.py | Sphinx configuration file. |
sphinx-doc/README.md | Instructions for docs generation. |
sphinx-doc/Makefile | Makefile for building Sphinx docs. |
requirements-test.txt | Test dependencies (pytest, coverage). |
requirements-docs.txt | Docs dependencies (Sphinx, theme). |
requirements-dev.txt | Development dependencies (code quality tools). |
pyproject.toml | Project metadata, packaging, and dependency config. |
mfd_kernel_namespace/network_namespace.py | Implements add_namespace_call_command function. |
mfd_kernel_namespace/exceptions.py | Placeholder for custom exceptions module. |
mfd_kernel_namespace/init.py | Exports core function in package API. |
examples/simple_example.py | Demonstrates usage of add_namespace_call_command . |
README.md | Project overview, API description, usage, supported OS. |
LICENSE.md | MIT license text. |
CONTRIBUTING.md | Contribution guidelines. |
AUTHORS.md | List of project authors. |
.github/workflows/pull_requests.yml | CI workflow for PR builds. |
.github/workflows/manual_release.yml | Manual dispatch release workflow. |
.github/workflows/codeql.yml | CodeQL analysis workflow. |
.github/workflows/build_upload_whl.yml | Reusable workflow for building and publishing wheels. |
Comments suppressed due to low confidence (3)
README.md:33
- [nitpick] The "OS supported" section lists ESXI and FREEBSD, but
ip netns exec
is Linux-specific. Clarify OS support or adjust the list to reflect actual compatibility.
* ESXI
mfd_kernel_namespace/network_namespace.py:13
- [nitpick] The function docstring is brief—consider expanding it to explain that it prepends
ip netns exec <namespace>
and wraps shell commands when necessary for clarity.
Add namespace call command to passed command if required.
mfd_kernel_namespace/network_namespace.py:20
- [nitpick] Consider adding unit tests for commands containing embedded quotes or other shell-sensitive characters to ensure the wrapper escapes them correctly.
command = f"sh -c '{command}'" if "echo" in command else command
No description provided.