diff --git a/README.rst b/README.rst index e7ac4fb..6dc51d3 100644 --- a/README.rst +++ b/README.rst @@ -43,6 +43,30 @@ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading `the Adafruit library and driver bundle `_. +Installing from PyPI +===================== +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. To install for current user: + +.. code-block:: shell + + pip3 install adafruit-circuitpython-ds1307 + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-ds1307 + +To install in a virtual environment in your current project: + +.. code-block:: shell + + mkdir project-name && cd project-name + python3 -m venv .env + source .env/bin/activate + pip3 install adafruit-circuitpython-ds1307 + Usage Notes =========== @@ -147,4 +171,4 @@ Now, once you have the virtual environment activated: This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to -locally verify it will pass. \ No newline at end of file +locally verify it will pass. diff --git a/adafruit_ds1307.py b/adafruit_ds1307.py index 764bf3f..adad09f 100644 --- a/adafruit_ds1307.py +++ b/adafruit_ds1307.py @@ -61,6 +61,10 @@ from adafruit_register import i2c_bit from adafruit_register import i2c_bcd_datetime +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DS1307.git" + + class DS1307: """Interface to the DS1307 RTC."""