File tree Expand file tree Collapse file tree 1 file changed +50
-4
lines changed Expand file tree Collapse file tree 1 file changed +50
-4
lines changed Original file line number Diff line number Diff line change 1- # pymodbus-repl
2- REPL client for pymodbus for quick CLI access
1+ # Pymodbus-REPL
32
4- ## Pymodbus Client
3+ Pymodbus-REPL is a REPL (Read-Eval-Print Loop) tool for working with Modbus devices using the Pymodbus library.
4+
5+ ## Development Setup
6+
7+ ### Prerequisites
8+
9+ - Python 3.8+
10+ - Poetry (installed globally or within a virtual environment)
11+
12+ ### Installation
13+
14+ 1 . Clone the repository:
15+
16+ ` git clone https://github.com/pymodbus-dev/repl.git `
17+
18+ 2 . Navigate to the project directory:
19+
20+ ` cd repl `
21+
22+ 3 . Install dependencies using Poetry:
23+
24+ ` poetry install `
25+
26+ ### Running Tests
27+ To run tests, use the following command:
28+
29+ ` poetry run pytest `
30+
31+ ### Building Distribution
32+ To build the distribution package, use the following command:
33+
34+ ` poetry build `
35+
36+ This will create distribution packages in the dist/ directory.
37+
38+ ## Usage
39+
40+ ### Pymodbus Client
541Refer [ REPL Client] ( ./pymodbus/repl/client/README.rst )
642
7- ## Pymodbus Server
43+ ### Pymodbus Server
844Refer [ REPL Server] ( ./pymodbus/repl/server/README.rst )
45+
46+ ## Contributing
47+ * Fork the repository.
48+ * Create a new branch (git checkout -b feature-name).
49+ * Make your changes and commit them (git commit -am 'Add feature').
50+ * Push to the branch (git push origin feature-name).
51+ * Create a new Pull Request.
52+
53+ ## License
54+ This project is licensed under the MIT License.
You can’t perform that action at this time.
0 commit comments