Merge pull request #10 from pimoroni/patch-prep-v0.0.5

Prep v0.0.5
pimoroni · Mar 18, 2021 · 510ebe2 · 510ebe2
2 parents d87741a + 6e76f6f
commit 510ebe2
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 47 deletions.
diff --git a/Makefile b/Makefile
@@ -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\n" >> library/README.md
+	cat library/CHANGELOG.txt >> library/README.
 
 library/LICENSE.txt: LICENSE
 	cp LICENSE library/LICENSE.txt

diff --git a/library/CHANGELOG.txt b/library/CHANGELOG.txt
@@ -1,3 +1,8 @@
+0.0.5
+-----
+
+* Bugfix: fix off-by-one error in sample average bitmask
+
 0.0.4
 -----
 

diff --git a/library/MANIFEST.in b/library/MANIFEST.in
@@ -1,5 +1,5 @@
 include CHANGELOG.txt
 include LICENSE.txt
-include README.rst
+include README.md
 include setup.py
 recursive-include max30105 *.py
diff --git a/library/README.md b/library/README.md
@@ -0,0 +1,27 @@
+# MAX30105 - Heart Rate, Oximeter, Smoke Sensor
+
+[![Build Status](https://travis-ci.com/pimoroni/max30105-python.svg?branch=master)](https://travis-ci.com/pimoroni/max30105-python)
+[![Coverage Status](https://coveralls.io/repos/github/pimoroni/max30105-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/max30105-python?branch=master)
+[![PyPi Package](https://img.shields.io/pypi/v/max30105.svg)](https://pypi.python.org/pypi/max30105)
+[![Python Versions](https://img.shields.io/pypi/pyversions/max30105.svg)](https://pypi.python.org/pypi/max30105)
+
+The MAX30105 is an precision optical sensor that can be used to measure heart rate, pulse oximetry (SPO2 / blood oxygen saturation), and smoke (and other particles).
+
+# Installing
+
+Stable library from PyPi:
+
+* Just run `sudo pip install max30105`
+
+Latest/development library from GitHub:
+
+* `git clone https://github.com/pimoroni/max30105-python`
+* `cd max30105-python`
+* `sudo ./install.sh`
+
+# Important!
+
+**This code should not be used for medical diagnosis, as the basis for a real smoke or fire detector, or in life-critical situations. It's for fun/novelty use only, so bear that in mind while using it.**
+
+# Changelog
+
diff --git a/library/README.rst b/library/README.rst
diff --git a/library/max30105/__init__.py b/library/max30105/__init__.py
@@ -5,7 +5,7 @@
 import time
 
 
-__version__ = '0.0.4'
+__version__ = '0.0.5'
 
 CHIP_ID = 0x15
 I2C_ADDRESS = 0x57

diff --git a/library/setup.py b/library/setup.py
@@ -39,11 +39,12 @@
 
 setup(
     name='max30105',
-    version='0.0.4',
+    version='0.0.5',
     author='Philip Howard',
     author_email='phil@pimoroni.com',
     description="""Python library for the MAX30105 Smoke/Pulse Detector""",
-    long_description=open('README.rst').read() + '\n' + open('CHANGELOG.txt').read(),
+    long_description=open('README.md').read() + '\n' + open('CHANGELOG.txt').read(),
+    long_description_content_type="text/markdown",
     license='MIT',
     keywords='Raspberry Pi',
     url='http://www.pimoroni.com',

diff --git a/library/tox.ini b/library/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = py{27,35,37},qa
+envlist = py{27,35,37,38},qa
 skip_missing_interpreters = True
 
 [testenv]
@@ -14,8 +14,11 @@ deps =
 
 [testenv:qa]
 commands =
+	check-manifest --ignore test.py,tox.ini,tests/*,.coveragerc
+	python setup.py sdist bdist_wheel
+	twine check dist/*
 	flake8 --ignore E501
-	rstcheck README.rst
 deps =
+	check-manifest
 	flake8
-	rstcheck
+	twine