You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-28Lines changed: 21 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,43 +50,24 @@ The first step to using this package is installing it on your system. The instal
50
50
51
51
### Python
52
52
53
-
The package is primarily installed using the `pip` command, downloading the package from the Python Index - "PyPi". Note - the below instructions outline installation an Linux-based (Raspberry Pi) system.
54
-
55
53
#### PyPi Installation
54
+
The package is primarily installed using the `pip3` command, downloading the package from the Python Index - "PyPi".
56
55
57
-
The SparkFun Qwiic Keypad Python package is part of the overall SparkFun Qwiic Python package which is hosted on PyPi. On systems that support PyPi installation via pip, this library is installed using the following commands
56
+
Note - the below instructions outline installation an Linux-based (Raspberry Pi) system.
58
57
59
-
For all users (note: the user must have sudo privileges):
58
+
First, setup a virtual environment from a specific directory using venv:
60
59
```sh
61
-
sudo pip install sparkfun-qwiic
60
+
python3 -m venv path/to/venv
62
61
```
63
-
For the current user:
62
+
You can pass any path as path/to/venv, just make sure you use the same one for all future steps. For more information on venv [click here](https://docs.python.org/3/library/venv.html).
64
63
64
+
Next, install the qwiic package with:
65
65
```sh
66
-
pip install sparkfun-qwiic
67
-
```
68
-
---
69
-
---
70
-
> [!CAUTION]
71
-
> **TODO** Put together how this works with the new virtual environments used with the latest Python install
72
-
---
73
-
---
74
-
#### Local Installation
75
-
To install, make sure the setuptools package is installed on the system.
If not already installed, follow the [instructions here](https://docs.circuitpython.org/projects/circup/en/latest/#installation) to install CircUp on your computer.
102
88
@@ -110,6 +96,13 @@ Finally, connect a device with CircuitPython installed to your computer and then
110
96
circup install --py qwiic_keypad
111
97
```
112
98
99
+
If you would like to install any of the examples from this repository, issue the corresponding circup command from below. (NOTE: The below syntax assumes you are using CircUp on Windows. Linux and Mac will have different path seperators (i.e. "/" vs. "\"). See the [CircUp "example" command documentation](https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup/example-command) for more information)
100
+
```sh
101
+
circup example qwiic_keypad\qwiic_keypad_ex1.py
102
+
circup example qwiic_keypad\qwiic_keypad_ex2.py
103
+
circup example qwiic_keypad\qwiic_keypad_ex3.py
104
+
```
105
+
113
106
Example Use
114
107
---------------
115
108
Below is a quickstart program to print which button was pressed or a space if '*' is pressed and a newline if '#' is pressed.
0 commit comments