PyVLCB 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
pyvlcb-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Stewart Watkiss
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
pyvlcb-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,95 @@
1
+ Metadata-Version: 2.4
2
+ Name: PyVLCB
3
+ Version: 0.1.0
4
+ Summary: A library for CBUS / VLCB communication
5
+ Author-email: "Stewart Watkiss (penguintutor)" <5587863+penguintutor@users.noreply.github.com>
6
+ License: MIT License
7
+
8
+ Copyright (c) 2026 Stewart Watkiss
9
+
10
+ Permission is hereby granted, free of charge, to any person obtaining a copy
11
+ of this software and associated documentation files (the "Software"), to deal
12
+ in the Software without restriction, including without limitation the rights
13
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14
+ copies of the Software, and to permit persons to whom the Software is
15
+ furnished to do so, subject to the following conditions:
16
+
17
+ The above copyright notice and this permission notice shall be included in all
18
+ copies or substantial portions of the Software.
19
+
20
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26
+ SOFTWARE.
27
+ Project-URL: Homepage, https://github.com/penguintutor/pyvlcb/
28
+ Project-URL: Documentation, https://www.penguintutor.com/projects/pyvlcb
29
+ Project-URL: Source, https://github.com/penguintutor/pyvlcb/
30
+ Classifier: License :: OSI Approved :: MIT License
31
+ Classifier: Programming Language :: Python :: 3
32
+ Requires-Python: >=3.6
33
+ Description-Content-Type: text/markdown
34
+ License-File: LICENSE
35
+ Requires-Dist: pyserial>=3.4
36
+ Dynamic: license-file
37
+
38
+ # PyVLCB Python Software Library for CBUS / VLCB
39
+
40
+ This is a small software library for CBUS and VLCB using Python.
41
+
42
+ It's designed for use with the MERG CANUSB4 CBUS adapter.
43
+
44
+
45
+ ## Install
46
+
47
+
48
+ For most systems including a Raspberry Pi then Python is managed using virtual environment.
49
+ To setup a virtual environment enter the following commands
50
+
51
+ mkdir ~/venv
52
+ python3 -m venv ~/venv/pyvlcb --system-site-packages
53
+
54
+ You will then need to run the following command to activate the virtual environment
55
+
56
+ source ~/venv/pyvlcb/bin/activate
57
+
58
+ To instally the latest release use
59
+
60
+ pip install pyvlcb
61
+
62
+
63
+ ## Development
64
+
65
+ The latest source code is available from GitHub. [PyVLCB on GitHub](https://github.com/penguintutor/pyvlcb).
66
+
67
+
68
+ ### Installing as a git submodule
69
+
70
+ To install the library, as a submodule in your own git project repository, then enter your project directory and run:
71
+
72
+ git submodule add https://github.com/penguintutor/pyvlcb.git lib/pyvlcb
73
+ pip install lib/pyvlcb
74
+
75
+ If you subsequently want to get the latest version of the library run a git pull then use the pip install command again.
76
+
77
+ _Important_ To use as a submodule you must create your own git project first and install within the project folder.
78
+
79
+ ## Library Reference
80
+
81
+ See the link below for the library reference documentation
82
+ [PyVLCB Library Reference Documentation](https://penguintutor.github.io/pyvlcb/reference/)
83
+
84
+
85
+ ## Demo examples
86
+
87
+ Example code is stored within the demo folder available from GitHub. Copy these into your project folder to test the library and connectivity.
88
+ The demos are created for a Raspberry Pi or other Linux computer. The USB port is hard-coded as /dev/ttyACM0
89
+ For other computers / USB ports then edit the python file directory and update the port statement.
90
+
91
+ ## More Details
92
+
93
+ For more details see: [PenguinTutor PyVLCB library page](https://www.penguintutor.com/projects/pyvlcb)
94
+
95
+ For an example of a program using this library see the [PenguinTutor Pi SignalBox project page](https://www.penguintutor.com/projects/pisignalbox)
pyvlcb-0.1.0/README.md ADDED
@@ -0,0 +1,58 @@
1
+ # PyVLCB Python Software Library for CBUS / VLCB
2
+
3
+ This is a small software library for CBUS and VLCB using Python.
4
+
5
+ It's designed for use with the MERG CANUSB4 CBUS adapter.
6
+
7
+
8
+ ## Install
9
+
10
+
11
+ For most systems including a Raspberry Pi then Python is managed using virtual environment.
12
+ To setup a virtual environment enter the following commands
13
+
14
+ mkdir ~/venv
15
+ python3 -m venv ~/venv/pyvlcb --system-site-packages
16
+
17
+ You will then need to run the following command to activate the virtual environment
18
+
19
+ source ~/venv/pyvlcb/bin/activate
20
+
21
+ To instally the latest release use
22
+
23
+ pip install pyvlcb
24
+
25
+
26
+ ## Development
27
+
28
+ The latest source code is available from GitHub. [PyVLCB on GitHub](https://github.com/penguintutor/pyvlcb).
29
+
30
+
31
+ ### Installing as a git submodule
32
+
33
+ To install the library, as a submodule in your own git project repository, then enter your project directory and run:
34
+
35
+ git submodule add https://github.com/penguintutor/pyvlcb.git lib/pyvlcb
36
+ pip install lib/pyvlcb
37
+
38
+ If you subsequently want to get the latest version of the library run a git pull then use the pip install command again.
39
+
40
+ _Important_ To use as a submodule you must create your own git project first and install within the project folder.
41
+
42
+ ## Library Reference
43
+
44
+ See the link below for the library reference documentation
45
+ [PyVLCB Library Reference Documentation](https://penguintutor.github.io/pyvlcb/reference/)
46
+
47
+
48
+ ## Demo examples
49
+
50
+ Example code is stored within the demo folder available from GitHub. Copy these into your project folder to test the library and connectivity.
51
+ The demos are created for a Raspberry Pi or other Linux computer. The USB port is hard-coded as /dev/ttyACM0
52
+ For other computers / USB ports then edit the python file directory and update the port statement.
53
+
54
+ ## More Details
55
+
56
+ For more details see: [PenguinTutor PyVLCB library page](https://www.penguintutor.com/projects/pyvlcb)
57
+
58
+ For an example of a program using this library see the [PenguinTutor Pi SignalBox project page](https://www.penguintutor.com/projects/pisignalbox)
@@ -0,0 +1,37 @@
1
+ [build-system]
2
+ requires = ["setuptools>=61.0", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "PyVLCB"
7
+ version = "0.1.0"
8
+ description = "A library for CBUS / VLCB communication"
9
+ readme = {file="README.md", content-type = "text/markdown"}
10
+ requires-python = ">=3.6"
11
+ license = {file = "LICENSE"}
12
+
13
+ # 'author' and 'author_email' become a list of tables
14
+ authors = [
15
+ {name = "Stewart Watkiss (penguintutor)", email = "5587863+penguintutor@users.noreply.github.com"}
16
+ ]
17
+
18
+ # 'classifiers' is copied directly
19
+ classifiers = [
20
+ "License :: OSI Approved :: MIT License",
21
+ "Programming Language :: Python :: 3",
22
+ ]
23
+
24
+ # 'install_requires' becomes 'dependencies'
25
+ dependencies = [
26
+ "pyserial>=3.4",
27
+ ]
28
+
29
+ # 'url' and 'project_urls' move here
30
+ [project.urls]
31
+ Homepage = "https://github.com/penguintutor/pyvlcb/"
32
+ Documentation = "https://www.penguintutor.com/projects/pyvlcb"
33
+ Source = "https://github.com/penguintutor/pyvlcb/"
34
+
35
+ # 'packages=find_packages()' moves to this specific tool section
36
+ [tool.setuptools.packages.find]
37
+ where = ["src"] # uses the src folder
pyvlcb-0.1.0/setup.cfg ADDED
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,95 @@
1
+ Metadata-Version: 2.4
2
+ Name: PyVLCB
3
+ Version: 0.1.0
4
+ Summary: A library for CBUS / VLCB communication
5
+ Author-email: "Stewart Watkiss (penguintutor)" <5587863+penguintutor@users.noreply.github.com>
6
+ License: MIT License
7
+
8
+ Copyright (c) 2026 Stewart Watkiss
9
+
10
+ Permission is hereby granted, free of charge, to any person obtaining a copy
11
+ of this software and associated documentation files (the "Software"), to deal
12
+ in the Software without restriction, including without limitation the rights
13
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14
+ copies of the Software, and to permit persons to whom the Software is
15
+ furnished to do so, subject to the following conditions:
16
+
17
+ The above copyright notice and this permission notice shall be included in all
18
+ copies or substantial portions of the Software.
19
+
20
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26
+ SOFTWARE.
27
+ Project-URL: Homepage, https://github.com/penguintutor/pyvlcb/
28
+ Project-URL: Documentation, https://www.penguintutor.com/projects/pyvlcb
29
+ Project-URL: Source, https://github.com/penguintutor/pyvlcb/
30
+ Classifier: License :: OSI Approved :: MIT License
31
+ Classifier: Programming Language :: Python :: 3
32
+ Requires-Python: >=3.6
33
+ Description-Content-Type: text/markdown
34
+ License-File: LICENSE
35
+ Requires-Dist: pyserial>=3.4
36
+ Dynamic: license-file
37
+
38
+ # PyVLCB Python Software Library for CBUS / VLCB
39
+
40
+ This is a small software library for CBUS and VLCB using Python.
41
+
42
+ It's designed for use with the MERG CANUSB4 CBUS adapter.
43
+
44
+
45
+ ## Install
46
+
47
+
48
+ For most systems including a Raspberry Pi then Python is managed using virtual environment.
49
+ To setup a virtual environment enter the following commands
50
+
51
+ mkdir ~/venv
52
+ python3 -m venv ~/venv/pyvlcb --system-site-packages
53
+
54
+ You will then need to run the following command to activate the virtual environment
55
+
56
+ source ~/venv/pyvlcb/bin/activate
57
+
58
+ To instally the latest release use
59
+
60
+ pip install pyvlcb
61
+
62
+
63
+ ## Development
64
+
65
+ The latest source code is available from GitHub. [PyVLCB on GitHub](https://github.com/penguintutor/pyvlcb).
66
+
67
+
68
+ ### Installing as a git submodule
69
+
70
+ To install the library, as a submodule in your own git project repository, then enter your project directory and run:
71
+
72
+ git submodule add https://github.com/penguintutor/pyvlcb.git lib/pyvlcb
73
+ pip install lib/pyvlcb
74
+
75
+ If you subsequently want to get the latest version of the library run a git pull then use the pip install command again.
76
+
77
+ _Important_ To use as a submodule you must create your own git project first and install within the project folder.
78
+
79
+ ## Library Reference
80
+
81
+ See the link below for the library reference documentation
82
+ [PyVLCB Library Reference Documentation](https://penguintutor.github.io/pyvlcb/reference/)
83
+
84
+
85
+ ## Demo examples
86
+
87
+ Example code is stored within the demo folder available from GitHub. Copy these into your project folder to test the library and connectivity.
88
+ The demos are created for a Raspberry Pi or other Linux computer. The USB port is hard-coded as /dev/ttyACM0
89
+ For other computers / USB ports then edit the python file directory and update the port statement.
90
+
91
+ ## More Details
92
+
93
+ For more details see: [PenguinTutor PyVLCB library page](https://www.penguintutor.com/projects/pyvlcb)
94
+
95
+ For an example of a program using this library see the [PenguinTutor Pi SignalBox project page](https://www.penguintutor.com/projects/pisignalbox)
@@ -0,0 +1,14 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ src/PyVLCB.egg-info/PKG-INFO
5
+ src/PyVLCB.egg-info/SOURCES.txt
6
+ src/PyVLCB.egg-info/dependency_links.txt
7
+ src/PyVLCB.egg-info/requires.txt
8
+ src/PyVLCB.egg-info/top_level.txt
9
+ src/pyvlcb/__init__.py
10
+ src/pyvlcb/canusb.py
11
+ src/pyvlcb/exceptions.py
12
+ src/pyvlcb/vlcbformat.py
13
+ src/pyvlcb/tests/run_tests.py
14
+ src/pyvlcb/tests/test_vlcb.py
@@ -0,0 +1 @@
1
+ pyserial>=3.4
@@ -0,0 +1 @@
1
+ pyvlcb