Skip to content

Commit 1db1b31

Browse files
niwciuniwciu
authored
Merge pull request #5 from niwciu/develop
PR for v1.0.3 release
2 parents b91a5a8 + 89d948e commit 1db1b31

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+3215
-1969
lines changed

‎.flake8‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# .flake8
2+
[flake8]
3+
max-line-length = 150
4+
extend-ignore = E203, W503

‎.github/workflows/ci.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main, develop]
6+
pull_request:
7+
branches: [main, develop]
8+
workflow_dispatch:
9+
10+
jobs:
11+
build:
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- uses: actions/checkout@v4
16+
17+
- name: Install system dependencies
18+
run: |
19+
sudo apt-get update
20+
sudo apt-get install -y \
21+
libegl-mesa0 \
22+
libegl1 \
23+
libgl1 \
24+
libgl1-mesa-dri \
25+
xvfb \
26+
libxrender1 \
27+
libxext6 \
28+
libxrandr2 \
29+
libxi6 \
30+
libfontconfig1 \
31+
libxcb-glx0 \
32+
libxcb-render0 \
33+
libxcb-shape0 \
34+
libxcb-xfixes0
35+
36+
- uses: actions/setup-python@v4
37+
with:
38+
python-version: '3.12.3'
39+
40+
- name: Install Python dependencies
41+
run: |
42+
python -m venv .venv
43+
.venv/bin/pip install --upgrade pip
44+
.venv/bin/pip install -e ".[dev]"
45+
46+
- name: Lint with flake8
47+
run: |
48+
.venv/bin/flake8 src/modbus_sniffer
49+
50+
- name: Run tests with Xvfb
51+
uses: GabrielBB/xvfb-action@v1
52+
with:
53+
run: .venv/bin/pytest --cov=src/modbus_sniffer tests/
54+
env:
55+
QT_QPA_PLATFORM: offscreen

‎.github/workflows/deploy_static.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Simple workflow for deploying static content to GitHub Pages
2+
name: Deploy static content to Pages
3+
4+
on:
5+
# Runs on pushes targeting the default branch
6+
push:
7+
branches: ["develop"]
8+
9+
# Allows you to run this workflow manually from the Actions tab
10+
workflow_dispatch:
11+
12+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
19+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: false
23+
24+
jobs:
25+
# Single deploy job since we're just deploying
26+
deploy:
27+
environment:
28+
name: github-pages
29+
url: ${{ steps.deployment.outputs.page_url }}
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Checkout
33+
uses: actions/checkout@v4
34+
- name: Copy changelo and contribututing files
35+
run: |
36+
cp CHANGELOG.md docs/
37+
cp CONTRIBUTING.md docs/
38+
- name: Setup Python
39+
uses: actions/setup-python@v4
40+
with:
41+
python-version: '3.x'
42+
43+
- name: Install dependencies
44+
run: |
45+
python -m pip install --upgrade pip
46+
pip install mkdocs-material
47+
48+
- name: Build MkDocs site
49+
run: mkdocs build --strict
50+
51+
- name: Setup Pages
52+
uses: actions/configure-pages@v5
53+
- name: Upload artifact
54+
uses: actions/upload-pages-artifact@v3
55+
with:
56+
# Upload entire repository
57+
path: 'site'
58+
- name: Deploy to GitHub Pages
59+
id: deployment
60+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
build/
1+
__pycache__/
2+
*.pyc
3+
*.log
24
dist/
3-
log*
4-
*.spec
5-
__pycache__
6-
.venv
5+
build/
6+
*.egg-info/
7+
.venv/
8+
logs/
9+
.coverage

‎CHANGELOG.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,33 @@
11
# Changelog
2+
3+
# v1.0.3 – What’s Changed 🚀
4+
5+
## ⚙️ CI/CD Improvements
6+
- 🛠️ Added new GitHub Actions workflows:
7+
- **deploy_static.yml** for auto-publishing the documentation site
8+
- **ci.yml** steps running smoke-tests on every push/pr with additional manual trigger
9+
10+
## 📦 PyPI Deployment & Project Restructure
11+
- 📂 Reorganized project into **src/** layout and added **pyproject.toml** per Python Packaging User Guide
12+
- 🧪 Introduced comprehensive test suite covering core functionality
13+
- 🏷️ Prepared metadata and packaging config for first PyPI release
14+
15+
## 📚 Documentation
16+
- 📁 Split docs into a dedicated **docs/** folder (MkDocs config) and added **CONTRIBUTING.md**
17+
- 🌐 Added GitHub Pages deployment instructions and static-site build scripts
18+
19+
## 🛠️ Installation Scripts
20+
- 📦 Moved all installers into **install_scripts/**:
21+
- Updated Windows `.bat` and Unix `.sh` scripts with improved error handling
22+
- Unified install paths and environment-setup steps
23+
24+
## 📈 CSV Logger Integration
25+
- 📝 Implemented **csv_logger** module to export captured frames and events to CSV witn hew parser (was a TODO in previous release)
26+
- 🔄 CSV logging can now be enabled via CLI/GUI flags for post-processing and analytics
27+
28+
**Full Changelog**: https://github.com/niwciu/ModbusSniffer/compare/v1.0.2...v1.0.3
29+
30+
231
# v1.0.2 – What's Changed 🚀
332

433
## 📦 Build System
@@ -18,6 +47,7 @@
1847
**Full Changelog**: https://github.com/niwciu/ModbusSniffer/compare/v1.0.1...v1.0.2
1948

2049
</br></br>
50+
2151
# v1.0.1 – What's Changed 🚀
2252

2353
## 🖥️ GUI Improvements
@@ -44,3 +74,11 @@ This project is a fork of [BADAndrea ModbusSniffer](https://github.com/BADAndrea
4474
- 🔄 CLI → GUI: All command-line functionality integrated into the GUI
4575
- 📋 Frame Table: Real-time view of the latest captured frames
4676
- 🌈 Live Logging: Color-coded request–response pairs; unmatched requests highlighted in red
77+
78+
<div align="center">
79+
80+
---
81+
<img src="https://github.com/user-attachments/assets/f4825882-e285-4e02-a75c-68fc86ff5716" alt="myEmbeddedWayBanerWhiteSmaller"/>
82+
83+
---
84+
</div>

0 commit comments

Comments
 (0)