sdwire 0.1.2__tar.gz → 0.2.1__tar.gz

{sdwire-0.1.2 → sdwire-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sdwire
-Version: 0.1.2
+Version: 0.2.1
 Summary: CLI application to interact with Badgerd SDWire Gen2 devices
 License: GPL-3
 Author: Talha Can Havadar
@@ -56,3 +56,60 @@ Commands:
   ts      ts/host => connects the sdcard interface to host machine
 ```
 
+## Installing
+
+Using pip
+
+```
+pip install sdwire
+```
+
+Using apt
+
+```
+sudo add-apt-repository ppa:tchavadar/badgerd
+sudo apt install python3-sdwire
+```
+
+## Listing SDWire Devices
+
+`sdwire list` command will search through usb devices connected to the system
+and prints out the list of gen2 and legacy devices.
+
+```
+❯ sdwire list
+Serial			Product Info
+sdwire_gen2_101		[SDWire-Gen2::Badgerd Technologies]
+bdgrd_sdwirec_522	[sd-wire::SRPOL]
+```
+
+## Switching SD Card Connection
+
+`sdwire switch` command switches the sd card connection to specified direction.
+If there is more than one sdwire connected to then you need specify which sdwire
+you want to alter with `--serial` or `-s` options.
+
+If there is only one sdwire connected then you dont need to specify the serial,
+it will pick the one connected automatically. See the examples below.
+
+```
+❯ sdwire list
+Serial			Product Info
+sdwire_gen2_101		[SDWire-Gen2::Badgerd Technologies]
+bdgrd_sdwirec_522	[sd-wire::SRPOL]
+
+❯ sdwire switch -s bdgrd_sdwirec_522 target
+
+❯ sdwire switch target
+Usage: sdwire switch [OPTIONS] COMMAND [ARGS]...
+Try 'sdwire switch --help' for help.
+
+Error: There is more then 1 sdwire device connected, please use --serial|-s to specify!
+
+❯ sdwire list
+Serial			Product Info
+bdgrd_sdwirec_522	[sd-wire::SRPOL]
+
+❯ sdwire switch host
+```
+

sdwire-0.2.1/README.md

@@ -0,0 +1,96 @@
+# CLI for Badgerd SDWire Devices
+
+Application also supports legacy SDWireC and non-Badger'd sdwires as well as
+new Badgerd SDwire Gen2 devices.
+
+Please see below for usage:
+
+```
+❯ sdwire --help
+Usage: sdwire [OPTIONS] COMMAND [ARGS]...
+
+Options:
+--help  Show this message and exit.
+
+Commands:
+list
+switch  dut/target => connects the sdcard interface to target device
+
+❯ sdwire switch --help
+Usage: sdwire switch [OPTIONS] COMMAND [ARGS]...
+
+  dut/target => connects the sdcard interface to target device
+
+  ts/host => connects the sdcard interface to host machine
+
+  off => disconnects the sdcard interface from both host and target
+
+Options:
+  -s, --serial TEXT  Serial number of the sdwire device, if there is only one
+                     sdwire connected then it will be used by default
+  --help             Show this message and exit.
+
+Commands:
+  dut     dut/target => connects the sdcard interface to target device
+  host    ts/host => connects the sdcard interface to host machine
+  off     off => disconnects the sdcard interface from both host and target
+  target  dut/target => connects the sdcard interface to target device
+  ts      ts/host => connects the sdcard interface to host machine
+```
+
+## Installing
+
+Using pip
+
+```
+pip install sdwire
+```
+
+Using apt
+
+```
+sudo add-apt-repository ppa:tchavadar/badgerd
+sudo apt install python3-sdwire
+```
+
+## Listing SDWire Devices
+
+`sdwire list` command will search through usb devices connected to the system
+and prints out the list of gen2 and legacy devices.
+
+```
+❯ sdwire list
+Serial			Product Info
+sdwire_gen2_101		[SDWire-Gen2::Badgerd Technologies]
+bdgrd_sdwirec_522	[sd-wire::SRPOL]
+```
+
+## Switching SD Card Connection
+
+`sdwire switch` command switches the sd card connection to specified direction.
+If there is more than one sdwire connected to then you need specify which sdwire
+you want to alter with `--serial` or `-s` options.
+
+If there is only one sdwire connected then you dont need to specify the serial,
+it will pick the one connected automatically. See the examples below.
+
+```
+❯ sdwire list
+Serial			Product Info
+sdwire_gen2_101		[SDWire-Gen2::Badgerd Technologies]
+bdgrd_sdwirec_522	[sd-wire::SRPOL]
+
+❯ sdwire switch -s bdgrd_sdwirec_522 target
+
+❯ sdwire switch target
+Usage: sdwire switch [OPTIONS] COMMAND [ARGS]...
+Try 'sdwire switch --help' for help.
+
+Error: There is more then 1 sdwire device connected, please use --serial|-s to specify!
+
+❯ sdwire list
+Serial			Product Info
+bdgrd_sdwirec_522	[sd-wire::SRPOL]
+
+❯ sdwire switch host
+```

{sdwire-0.1.2 → sdwire-0.2.1}/pyproject.toml

@@ -1,15 +1,11 @@
 [tool.poetry]
 name = "sdwire"
-version = "0.1.2"
+version = "0.2.1"
 description = "CLI application to interact with Badgerd SDWire Gen2 devices"
 authors = ["Talha Can Havadar <havadartalha@gmail.com>"]
 license = "GPL-3"
 readme = "README.md"
-packages = [
-    { include = "constants.py", from = "sdwire" },
-    { include = "backend", from = "sdwire" },
-    { include = "sdwire" },
-]
+packages = [{ include = "sdwire" }]
 
 [tool.poetry.dependencies]
 python = "^3.12"

{sdwire-0.1.2 → sdwire-0.2.1}/sdwire/backend/detect.py

@@ -3,10 +3,10 @@ from typing import List
 from adafruit_board_toolkit import circuitpython_serial as cpserial
 from serial.tools.list_ports_common import ListPortInfo
 
-import constants
-from backend.device.sdwire import SDWire
-from backend.device.sdwirec import SDWireC
-from backend.device.usb_device import PortInfo
+from sdwire import constants
+from .device.sdwire import SDWire
+from .device.sdwirec import SDWireC
+from .device.usb_device import PortInfo
 
 import usb.core
 import usb.util

{sdwire-0.1.2 → sdwire-0.2.1}/sdwire/backend/device/sdwire.py

@@ -1,5 +1,5 @@
 from serial import Serial
-from backend.device.usb_device import USBDevice, PortInfo
+from .usb_device import USBDevice, PortInfo
 
 
 class SDWire(USBDevice):

{sdwire-0.1.2 → sdwire-0.2.1}/sdwire/backend/device/sdwirec.py

@@ -1,7 +1,7 @@
 import logging
 from pyftdi.ftdi import Ftdi
 from serial import Serial
-from backend.device.usb_device import USBDevice, PortInfo
+from .usb_device import USBDevice, PortInfo
 
 log = logging.getLogger(__name__)
 

{sdwire-0.1.2 → sdwire-0.2.1}/sdwire/backend/utils.py

@@ -1,9 +1,9 @@
 import sys
 import logging
 import click
-from backend.device.sdwire import SDWire
-from backend.device.sdwirec import SDWireC
-from backend import detect
+from .device.sdwire import SDWire
+from .device.sdwirec import SDWireC
+from . import detect
 
 log = logging.getLogger(__name__)
 

{sdwire-0.1.2 → sdwire-0.2.1}/sdwire/main.py

@@ -1,8 +1,8 @@
 #!/usr/bin/env python
 import click
-from backend import utils
-from backend import detect
-from backend.device.sdwire import SDWire
+from .backend import utils
+from .backend import detect
+from .backend.device.sdwire import SDWire
 
 
 @click.group()

sdwire-0.1.2/README.md

@@ -1,39 +0,0 @@
-# CLI for Badgerd SDWire Devices
-
-Application also supports legacy SDWireC and non-Badger'd sdwires as well as
-new Badgerd SDwire Gen2 devices.
-
-Please see below for usage:
-
-```
-❯ sdwire --help
-Usage: sdwire [OPTIONS] COMMAND [ARGS]...
-
-Options:
---help  Show this message and exit.
-
-Commands:
-list
-switch  dut/target => connects the sdcard interface to target device
-
-❯ sdwire switch --help
-Usage: sdwire switch [OPTIONS] COMMAND [ARGS]...
-
-  dut/target => connects the sdcard interface to target device
-
-  ts/host => connects the sdcard interface to host machine
-
-  off => disconnects the sdcard interface from both host and target
-
-Options:
-  -s, --serial TEXT  Serial number of the sdwire device, if there is only one
-                     sdwire connected then it will be used by default
-  --help             Show this message and exit.
-
-Commands:
-  dut     dut/target => connects the sdcard interface to target device
-  host    ts/host => connects the sdcard interface to host machine
-  off     off => disconnects the sdcard interface from both host and target
-  target  dut/target => connects the sdcard interface to target device
-  ts      ts/host => connects the sdcard interface to host machine
-```