Prep for v0.0.4

Author: Gadgetoid

Makefile

@@ -9,7 +9,7 @@ usage:
 	@echo "install:       install the library locally from source"
 	@echo "uninstall:     uninstall the local library"
 	@echo "check:         peform basic integrity checks on the codebase"
-	@echo "python-readme: generate library/README.rst from README.md"
+	@echo "python-readme: generate library/README.md from README.md"
 	@echo "python-wheels: build python .whl files for distribution"
 	@echo "python-sdist:  build python source distribution"
 	@echo "python-clean:  clean python build and dist directories"
@@ -36,12 +36,14 @@ check:
 tag:
 	git tag -a "v${LIBRARY_VERSION}" -m "Version ${LIBRARY_VERSION}"
 
-python-readme: library/README.rst
+python-readme: library/README.md
 
 python-license: library/LICENSE.txt
 
-library/README.rst: README.md
-	pandoc --from=markdown --to=rst -o library/README.rst README.md
+library/README.md: README.md library/CHANGELOG.txt
+	cp README.md library/README.md
+	printf "\n# Changelog\n" >> library/README.md
+	cat library/CHANGELOG.txt >> library/README.md
 
 library/LICENSE.txt: LICENSE
 	cp LICENSE library/LICENSE.txt

library/CHANGELOG.txt

@@ -1,3 +1,11 @@
+0.0.4
+-----
+
+* Add support for forced-mode on demand i2c
+* Change altitude formula
+* Allow manual temperature compensation for altitude
+* Allow oversampling settings to be configured on `__init__`
+
 0.0.3
 -----
 

library/MANIFEST.in

@@ -1,5 +1,5 @@
 include CHANGELOG.txt
 include LICENSE.txt
-include README.rst
+include README.md
 include setup.py
 recursive-include bmp280 *.py

library/README.md

@@ -0,0 +1,46 @@
+# BMP280 Temperature, Pressure, & Altitude Sensor
+
+[![Build Status](https://travis-ci.com/pimoroni/bmp280-python.svg?branch=master)](https://travis-ci.com/pimoroni/bmp280-python)
+[![Coverage Status](https://coveralls.io/repos/github/pimoroni/bmp280-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/bmp280-python?branch=master)
+[![PyPi Package](https://img.shields.io/pypi/v/bmp280.svg)](https://pypi.python.org/pypi/bmp280)
+[![Python Versions](https://img.shields.io/pypi/pyversions/bmp280.svg)](https://pypi.python.org/pypi/bmp280)
+
+Suitable for measuring ambient temperature, barometric pressure, and altitude, the BMP280 is a basic weather sensor.
+
+# Installing
+
+Stable library from PyPi:
+
+* Just run `sudo pip install bmp280`
+
+Latest/development library from GitHub:
+
+* `git clone https://github.com/pimoroni/bmp280-python`
+* `cd bmp280-python`
+* `sudo ./install.sh`
+
+
+# Changelog
+0.0.4
+-----
+
+* Add support for forced-mode on demand i2c
+* Change altitude formula
+* Allow manual temperature compensation for altitude
+* Allow oversampling settings to be configured on `__init__`
+
+0.0.3
+-----
+
+* Migrate to i2cdevice>=0.0.6 set/get API
+
+0.0.2
+-----
+
+* Added `get_altitude` method
+* Corrected pressure to hPa
+
+0.0.1
+-----
+
+* Initial Release

library/README.rst

@@ -5,7 +5,7 @@
 import time
 
 
-__version__ = '0.0.3'
+__version__ = '0.0.4'
 
 CHIP_ID = 0x58
 I2C_ADDRESS_GND = 0x76
@@ -199,8 +199,8 @@ def get_pressure(self):
         return self.pressure
 
     def get_altitude(self, qnh=1013.25, manual_temperature=None):
-        # qnh = pressure at sea level where the readings are being taken.  
-        # The temperature should be the outdoor temperature. 
+        # qnh = pressure at sea level where the readings are being taken.
+        # The temperature should be the outdoor temperature.
         # Use the manual_temperature variable if temperature adjustments are required.
         self.update_sensor()
         pressure = self.get_pressure()

library/bmp280/__init__.py

@@ -39,11 +39,12 @@
 
 setup(
     name='bmp280',
-    version='0.0.3',
+    version='0.0.4',
     author='Philip Howard',
     author_email='phil@pimoroni.com',
     description="""Python library for the BMP280 temperature and pressure sensor""",
-    long_description=open('README.rst').read() + '\n' + open('CHANGELOG.txt').read(),
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
     license='MIT',
     keywords='Raspberry Pi',
     url='http://www.pimoroni.com',