cjn-PiTools 1.0__tar.gz

cjn_pitools-1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Chris Nelson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cjn_pitools-1.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: cjn_PiTools
+Version: 1.0
+Summary: cjn's library of Raspberry Pi functions, drivers, tools, ...
+Author-email: Chris Nelson <github@cjnaz.com>
+License-Expression: MIT
+Project-URL: repository, https://github.com/cjnaz/cjn_PiTools
+Keywords: cjnaz,library,cjnfuncs
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cjnfuncs>=3.1.1
+Requires-Dist: luma.oled
+Requires-Dist: pillow
+Requires-Dist: spidev
+Requires-Dist: RPi.GPIO
+Provides-Extra: pigpio
+Requires-Dist: pigpio; extra == "pigpio"
+Dynamic: license-file
+
+# cjn_PiTools - A collection of modules for Raspberry Pi projects
+
+## cjn_PiTools is comprised of several modules (follow links to respective documentation)
+
+NOTE:  These link point to the github repo since relative links to other .md files do not work on PyPI.
+
+Module | Description/Purpose
+--|--
+[PiBlinky](https://github.com/cjnaz/cjn_PiTools/blob/main/PiBlinky.md)       | A multiple threaded LED driver for Raspberry Pi
+[PiOLED](https://github.com/cjnaz/cjn_PiTools/blob/main/PiOLED.md)           | Display multi-line messages on a shared Raspberry Pi connected OLED display
+[DS18B20](https://github.com/cjnaz/cjn_PiTools/blob/main/DS18B20.md)         | A high-featured library/driver using the w1_therm kernel driver
+[initW1buses](https://github.com/cjnaz/cjn_PiTools/blob/main/initW1buses.md) | Initialize the W1 buses and set write permission on found therm_bulk_read file(s)
+
+More to come!
+- Drivers for SHT3x and HTU21D temp/RH sensors
+- Driver for ADC121C027 ADC
+- Driver for MCP23008 IO expander
+- Driver for PCA9548s I2C expander
+
+In most cases, these drivers will work with both `RPi.GPIO` (for local control) and `pigpio` for (local and remote control).
+
+Developed and tested on Raspbian GNU/Linux 11 (bullseye) and Python 3.9.2, and supported on all higher versions.
+
+In this documentation, "tool script" refers to a Python project that imports and uses cjn_PiTools. Some may be simple scripts, and others may themselves be installed packages.
+
+<br/>
+
+## Installation and usage
+
+If using the RPi.GPIO driver:
+
+    pip install cjn_PiTools
+
+
+If using the pigpio driver:
+
+    pip install cjn_PiTools[pigpio]
+
+- And you will also need to install the pigpiod daemon (`sudo apt install pigpiod`) and start it manually or at boot.  Here's a systemd service file for starting pigpiod at boot:
+
+        [Unit]
+        Description=Daemon required to control GPIO pins via pigpio
+
+        [Service]
+        ExecStart=/usr/local/bin/pigpiod -l
+        Type=forking
+        TimeoutStopSec=20
+
+        [Install]
+        WantedBy=multi-user.target
+
+
+
+<br/>
+
+## Key changes since the prior major public release (this is the first release)
+
+- New.  Bundled PiBlinky, PiOLED, initW1buses, and DS18B20 modules
+
+<br/>
+
+## Revision history
+- 1.0 260207 - New.  Bundled PiBlinky, PiOLED, initW1buses, and DS18B20 modules

cjn_pitools-1.0/README.md

@@ -0,0 +1,63 @@
+# cjn_PiTools - A collection of modules for Raspberry Pi projects
+
+## cjn_PiTools is comprised of several modules (follow links to respective documentation)
+
+NOTE:  These link point to the github repo since relative links to other .md files do not work on PyPI.
+
+Module | Description/Purpose
+--|--
+[PiBlinky](https://github.com/cjnaz/cjn_PiTools/blob/main/PiBlinky.md)       | A multiple threaded LED driver for Raspberry Pi
+[PiOLED](https://github.com/cjnaz/cjn_PiTools/blob/main/PiOLED.md)           | Display multi-line messages on a shared Raspberry Pi connected OLED display
+[DS18B20](https://github.com/cjnaz/cjn_PiTools/blob/main/DS18B20.md)         | A high-featured library/driver using the w1_therm kernel driver
+[initW1buses](https://github.com/cjnaz/cjn_PiTools/blob/main/initW1buses.md) | Initialize the W1 buses and set write permission on found therm_bulk_read file(s)
+
+More to come!
+- Drivers for SHT3x and HTU21D temp/RH sensors
+- Driver for ADC121C027 ADC
+- Driver for MCP23008 IO expander
+- Driver for PCA9548s I2C expander
+
+In most cases, these drivers will work with both `RPi.GPIO` (for local control) and `pigpio` for (local and remote control).
+
+Developed and tested on Raspbian GNU/Linux 11 (bullseye) and Python 3.9.2, and supported on all higher versions.
+
+In this documentation, "tool script" refers to a Python project that imports and uses cjn_PiTools. Some may be simple scripts, and others may themselves be installed packages.
+
+<br/>
+
+## Installation and usage
+
+If using the RPi.GPIO driver:
+
+    pip install cjn_PiTools
+
+
+If using the pigpio driver:
+
+    pip install cjn_PiTools[pigpio]
+
+- And you will also need to install the pigpiod daemon (`sudo apt install pigpiod`) and start it manually or at boot.  Here's a systemd service file for starting pigpiod at boot:
+
+        [Unit]
+        Description=Daemon required to control GPIO pins via pigpio
+
+        [Service]
+        ExecStart=/usr/local/bin/pigpiod -l
+        Type=forking
+        TimeoutStopSec=20
+
+        [Install]
+        WantedBy=multi-user.target
+
+
+
+<br/>
+
+## Key changes since the prior major public release (this is the first release)
+
+- New.  Bundled PiBlinky, PiOLED, initW1buses, and DS18B20 modules
+
+<br/>
+
+## Revision history
+- 1.0 260207 - New.  Bundled PiBlinky, PiOLED, initW1buses, and DS18B20 modules

cjn_pitools-1.0/pyproject.toml

@@ -0,0 +1,53 @@
+[project]
+name = 'cjn_PiTools'
+version = "1.0"
+    # 1.0 - New.  Bundled PiBlinky, PiOLED, initW1buses, and DS18B20 modules
+description = "cjn's library of Raspberry Pi functions, drivers, tools, ..."
+readme = "README.md"
+requires-python = ">=3.9"
+authors = [ {name = "Chris Nelson", email = "github@cjnaz.com"} ]
+license = "MIT"
+dependencies = [
+    'cjnfuncs >= 3.1.1',
+    'luma.oled',
+    'pillow',
+    'spidev',
+    'RPi.GPIO',
+    ]
+keywords = ['cjnaz', 'library', 'cjnfuncs']
+classifiers = [                 # https://pypi.org/classifiers/
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    ]
+
+
+[project.optional-dependencies]
+pigpio = [
+    "pigpio",
+    ]
+
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+
+[project.scripts]
+PiOLED =        'cjn_PiTools.PiOLED:cli'
+DS18B20 =       'cjn_PiTools.DS18B20:cli'
+initW1buses =   'cjn_PiTools.initW1buses:cli'
+
+
+[project.urls]
+repository = "https://github.com/cjnaz/cjn_PiTools"
+
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+
+[tool.setuptools]
+include-package-data = true
+
+
+[tool.setuptools.package-data]
+'*' = ['fonts/*', 'deployment_files/*']

cjn_pitools-1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+