Skip to content

Commit 7308db7

Browse files
committed
Add version info, PyPI README
1 parent f7a6366 commit 7308db7

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

README.rst

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

46+
Installing from PyPI
47+
=====================
48+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
49+
PyPI <https://pypi.org/project/adafruit-circuitpython-ds1307/>`_. To install for current user:
50+
51+
.. code-block:: shell
52+
53+
pip3 install adafruit-circuitpython-ds1307
54+
55+
To install system-wide (this may be required in some cases):
56+
57+
.. code-block:: shell
58+
59+
sudo pip3 install adafruit-circuitpython-ds1307
60+
61+
To install in a virtual environment in your current project:
62+
63+
.. code-block:: shell
64+
65+
mkdir project-name && cd project-name
66+
python3 -m venv .env
67+
source .env/bin/activate
68+
pip3 install adafruit-circuitpython-ds1307
69+
4670
Usage Notes
4771
===========
4872

@@ -147,4 +171,4 @@ Now, once you have the virtual environment activated:
147171
148172
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
149173
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
150-
locally verify it will pass.
174+
locally verify it will pass.

adafruit_ds1307.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@
6161
from adafruit_register import i2c_bit
6262
from adafruit_register import i2c_bcd_datetime
6363

64+
__version__ = "0.0.0-auto.0"
65+
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DS1307.git"
66+
67+
6468
class DS1307:
6569
"""Interface to the DS1307 RTC."""
6670

0 commit comments

Comments
 (0)