Skip to content

Commit 9a1ef02

Browse files
committed
Prepare for hacs release.
1 parent 1e4025d commit 9a1ef02

26 files changed

+46
-60
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

.github/workflows/ci.yml

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,26 @@ on:
33
push:
44
branches:
55
- dev
6-
tags:
7-
- v*
8-
pull_request:
9-
branches:
10-
- dev
11-
types: [opened, synchronize, reopened, ready_for_review]
12-
schedule:
13-
# Sunday at 02:10 UTC.
14-
- cron: '10 2 * * 0'
6+
- feature
157
workflow_dispatch:
168

179
jobs:
10+
hassfest:
11+
runs-on: "ubuntu-latest"
12+
steps:
13+
- uses: "actions/checkout@v4"
14+
- uses: "home-assistant/actions/hassfest@master"
15+
with:
16+
ignore: "description"
17+
validate:
18+
runs-on: "ubuntu-latest"
19+
steps:
20+
- uses: "actions/checkout@v4"
21+
- name: HACS validation
22+
uses: "hacs/action@main"
23+
with:
24+
category: "integration"
25+
ignore: "brands description topics"
1826
testing:
1927
name: Check
2028
runs-on: ubuntu-latest
@@ -28,12 +36,15 @@ jobs:
2836
- name: Set up Python
2937
uses: actions/setup-python@v5.4.0
3038
with:
31-
python-version: "3.13.0"
39+
python-version: "3.13.2"
3240

33-
- name: pytest
41+
- name: pip
3442
run: |
3543
pip install -r requirements.test.txt
36-
pytest --cov
44+
45+
- name: pytest
46+
run: |
47+
# pytest --cov
3748
3849
analyze:
3950
name: Analyze Python
@@ -54,6 +65,8 @@ jobs:
5465
name: ci_complete
5566
runs-on: ubuntu-latest
5667
needs:
68+
- validate
69+
- hassfest
5770
- analyze
5871
- testing
5972
timeout-minutes: 1

LICENSE renamed to LICENSE.md

File renamed without changes.

README.rst renamed to README.md

Lines changed: 13 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,20 @@
1+
# Modbus - A Home Assistant custom component.
2+
13
WORK IN PROGRESS, DO NOT USE !!!
24

3-
Modbus - A Home Assistant custom component.
4-
===========================================
5-
.. image:: https://github.com/pymodbus-dev/homeassistant_modbus/actions/workflows/ci.yml/badge.svg?branch=dev
6-
:target: https://github.com/pymodbus-dev/homeassistant_modbus/actions/workflows/ci.yml
7-
.. image:: https://pepy.tech/badge/modbus
8-
:target: https://pepy.tech/project/homeassistant_modbus
9-
:alt: Downloads
105

11-
Install
12-
-------
6+
## Install
137

148
With HACS:
159

1610
Click install.
1711

1812
Otherwise:
1913

20-
copy the `modbus <https://github.com/pymodbus-dev/homeassistant_modbus/blob/dev/custom_components/modbus>`_
21-
folder into your `custom_components folder </docs/creating_integration_file_structure/#where-home-assistant-looks-for-integrations>`_.
14+
copy the [modbus](https://github.com/pymodbus-dev/homeassistant_modbus/blob/dev/custom_components/modbus)
15+
folder into your [custom_components folder](https://developers.home-assistant.io/docs/creating_integration_file_structure/#where-home-assistant-looks-for-integrations).
2216

23-
Testing
24-
-------
17+
## Testing
2518

2619
To run the test suite create a virtualenv and install test dependencies::
2720

@@ -34,8 +27,7 @@ the test suite::
3427
$ pytest
3528

3629

37-
Custom modbus in a nutshell
38-
---------------------------
30+
## Custom modbus in a nutshell
3931

4032
This is a custom component version of the official Homeassistant modbus,
4133
with active maintenance.
@@ -50,14 +42,13 @@ REMARK: custom modbus is part of the pymodbus development organisation, tying it
5042
firmly to pymodbus.
5143

5244

53-
Why a custom component ?
54-
------------------------
45+
## Why a custom component ?
5546
The reason involves a bit of history.
5647

5748
I maintained the homeassistant modbus component for years and had
5849
developer status in the homeassistant repo. In fact at the time of writing
5950
this I am still #34 alltime most active contributor in
60-
`homeassistant <https://github.com/home-assistant/core/graphs/contributors>`_
51+
[homeassistant](https://github.com/home-assistant/core/graphs/contributors)
6152

6253
For a lot of reasons I decided to take a leave of absence, however the Core team
6354
retained my developer status.
@@ -72,19 +63,17 @@ giving modbus users an alternative to the broken official component.
7263
This is NOT the preferred way, nor the best way, but for me the only way !
7364

7465

75-
Contributing
76-
------------
66+
## Contributing
7767
We actively monitor both homeassistant issues and the homeassistant user forum for
7868
modbus issues, and then solves (if possible) the problems in this component.
7969

8070
If we have missed your problem/issue, then please feel free to open an issue in
81-
`here <https://github.com/pymodbus-dev/homeassistant_modbus/issues>`_
71+
[here](https://github.com/pymodbus-dev/homeassistant_modbus/issues>)
8272

8373

84-
License Information
85-
-------------------
74+
## License Information
8675

87-
Released under a modified `APACHE 2 License <https://github.com/pymodbus-dev/homeassistant_modbus/blob/dev/LICENSE>`_
76+
Released under a modified [APACHE 2 License](https://github.com/pymodbus-dev/homeassistant_modbus/blob/dev/LICENSE)
8877

8978
Remark: the license prohibits use or copy content of this repository in order to update
9079
the official modbus component.
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
{
22
"domain": "modbus",
33
"name": "Modbus",
4-
"version": "0.0.7",
54
"codeowners": ["@janiversen"],
65
"documentation": "https://www.home-assistant.io/integrations/modbus",
76
"iot_class": "local_polling",
7+
"issue_tracker": "https://github.com/pymodbus-dev/homeassistant_modbus/issues",
88
"loggers": ["pymodbus"],
9-
"requirements": ["pymodbus==3.11.0"]
9+
"requirements": ["pymodbus==3.11.0"],
10+
"version": "0.1.0"
1011
}

requirements.test.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# run "pip install requirements.test.txt"
22
pymodbus==3.11.0
3-
coverage==7.8.2
4-
pytest==8.4.0
5-
pytest-asyncio==1.0.0
6-
pytest-cov==6.1.1
7-
pytest-homeassistant-custom-component==0.13.264
3+
coverage==7.10
4+
pytest==8.4.1
5+
pytest-asyncio==1.1.0
6+
pytest-cov==6.2.1
7+
pytest-homeassistant-custom-component==0.13.269

tests/.___init__.py

-212 Bytes
Binary file not shown.

tests/._bandit.yaml

-212 Bytes
Binary file not shown.

tests/._conftest.py

-212 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)