nicolas
/
pyhoff
mirror of https://github.com/Nonannet/pyhoff.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

readme updated

This commit is contained in:
Nicolas 2025-06-12 14:36:17 +02:00 committed by Nicolas Kruse
parent 6cb3e216a2
commit ddec81acaa
1 changed files with 6 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,6 +1,5 @@
# Pyhoff # Pyhoff
## Description
The pyhoff package allows you to read and write the most common The pyhoff package allows you to read and write the most common
Beckhoff and WAGO bus terminals ("Busklemmen") using the Ethernet bus Beckhoff and WAGO bus terminals ("Busklemmen") using the Ethernet bus
coupler ("Busskoppler") BK9000, BK9050, BK9100, or WAGO 750_352 coupler ("Busskoppler") BK9000, BK9050, BK9100, or WAGO 750_352
@ -62,32 +61,24 @@ Please open an issue or submit a pull request on GitHub.
## Developer Guide ## Developer Guide
To get started with developing the `pyhoff` package, follow these steps: To get started with developing the `pyhoff` package, follow these steps:
1. **Clone the Repository** 1. First, clone the repository to your local machine using Git:
First, clone the repository to your local machine using Git:
```bash ```bash
git clone https://github.com/Nonannet/pyhoff.git git clone https://github.com/Nonannet/pyhoff.git
cd pyhoff cd pyhoff
``` ```
2. **Set Up a Virtual Environment** 2. It is recommended to use a virtual environment:
It is recommended to use a virtual environment to manage dependencies. You can create one using `venv`:
```bash ```bash
python -m venv venv python -m venv .venv
source venv/bin/activate # On Windows use `venv\Scripts\activate` source .venv/bin/activate # On Windows/Powershell use `.\venv\Scripts\Activate.ps1`
``` ```
3. **Install Dev Dependencies** 3. Install pyhoff from source plus the development dependencies:
Install pyhoff from source plus the dependencies required for development using `pip`:
```bash ```bash
pip install -e .[dev] pip install -e .[dev]
``` ```
4. **Run Tests** 4. Ensure that everything is set up correctly by running the tests:
Ensure that everything is set up correctly by running the tests:
```bash ```bash
pytest pytest
``` ```