Skip to content

Commit 54d497c

Browse files
authored
Merge pull request #11 from kattni/fix-up
Update version info, README
2 parents d0a0d2c + 347cea4 commit 54d497c

File tree

3 files changed

+31
-1
lines changed

3 files changed

+31
-1
lines changed

README.rst

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,30 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2727
This is easily achieved by downloading
2828
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
2929

30+
Installing from PyPI
31+
=====================
32+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
33+
PyPI <https://pypi.org/project/adafruit-circuitpython-waveform/>`_. To install for current user:
34+
35+
.. code-block:: shell
36+
37+
pip3 install adafruit-circuitpython-waveform
38+
39+
To install system-wide (this may be required in some cases):
40+
41+
.. code-block:: shell
42+
43+
sudo pip3 install adafruit-circuitpython-waveform
44+
45+
To install in a virtual environment in your current project:
46+
47+
.. code-block:: shell
48+
49+
mkdir project-name && cd project-name
50+
python3 -m venv .env
51+
source .env/bin/activate
52+
pip3 install adafruit-circuitpython-waveform
53+
3054
Usage Example
3155
=============
3256

@@ -90,4 +114,3 @@ Now, once you have the virtual environment activated:
90114
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
91115
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
92116
locally verify it will pass.
93-

adafruit_waveform/sine.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@
3232
import array
3333
import math
3434

35+
__version__ = "0.0.0-auto.0"
36+
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Waveform.git"
37+
38+
3539
def sine_wave(sample_frequency, pitch):
3640
"""Generate a single sine wav cycle at the given sampling frequency and pitch."""
3741
length = int(sample_frequency / pitch)

adafruit_waveform/square.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@
3131

3232
import array
3333

34+
__version__ = "0.0.0-auto.0"
35+
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Waveform.git"
36+
3437

3538
def square_wave(sample_length=2):
3639
"""Generate a single square wave of sample_length size"""

0 commit comments

Comments
 (0)