Skip to content

feat: Initial commit#1

Merged
abaczek merged 1 commit intomainfrom
first_release
Jul 10, 2025
Merged

feat: Initial commit#1
abaczek merged 1 commit intomainfrom
first_release

Conversation

@abaczek
Copy link
Contributor

@abaczek abaczek commented Jul 10, 2025

No description provided.

@mfd-intel-bot
Copy link

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

1 similar comment
@mfd-intel-bot
Copy link

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

@github-advanced-security
Copy link

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.

@adrianlasota adrianlasota requested a review from Copilot July 10, 2025 14:00

This comment was marked as outdated.

@mfd-intel-bot
Copy link

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

1 similar comment
@mfd-intel-bot
Copy link

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

@adrianlasota adrianlasota requested a review from Copilot July 10, 2025 14:18
Copy link

Copilot AI left a 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 introducing the SerialConnection module, tests, documentation scaffolding, and CI/CD setup.

  • Implement core SerialConnection class with send, read, timed-read, and background-reading features.
  • Add unit tests for basic reading and context-manager behavior.
  • Establish Sphinx documentation, example script, and GitHub Actions workflows for build, test, and release.

Reviewed Changes

Copilot reviewed 26 out of 29 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
mfd_serial/serial.py Core SerialConnection implementation
tests/unit/test_serial/test_serial.py Unit tests covering read and context manager
README.md Usage instructions and examples
sphinx-doc/index.rst Documentation entry points
.github/workflows/build_upload_whl.yml CI workflow for building and publishing wheel
Comments suppressed due to low confidence (3)

README.md:21

  • Method name in code is send, not write. Update the docs to call serial.send('Text to send').
serial.write('Text to send')

README.md:41

  • The class is named SerialConnection, not SerialDriver. Update the text for consistency.
SerialDriver can be used as context manager:  

mfd_serial/serial.py:45

  • The send method is not covered by any unit tests. Consider adding a test that mocks the underlying serial port and verifies that write is called with the correctly encoded message.
    def send(self, msg: str) -> None:

Signed-off-by: Baczek, Arkadiusz <arkadiusz.baczek@intel.com>
@mfd-intel-bot
Copy link

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

1 similar comment
@mfd-intel-bot
Copy link

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

@abaczek abaczek merged commit e88f967 into main Jul 10, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants