Merge pull request #59 from nikhiljohn10/develop

1.4.2

Makefile

@@ -8,6 +8,9 @@ DOCTHEME    := sphinx_rtd_theme
 RELEASE     := $(shell cat $(SRCDIR)/__init__.py | grep __version__ | sed -e 's/^.* = '\''//' -e 's/'\''//')
 VERSION     := $(shell echo $(RELEASE) | sed -e 's/^\([0-9]*\.[0-9]*\).*$$/\1/')
 
+PY_VER      := $(shell python3 -V | sed -e 's/^Python //')
+PYAUDIO     := 0.2.11
+
 help: version
 	@echo "Please use 'make <target>' where <target> is one of"
 	@echo "  version        to display package version"
@@ -20,6 +23,7 @@ help: version
 	@echo "  test-publish   to upload python package to TestPyPi server"
 	@echo "  install        to install python package from PyPi server"
 	@echo "  test-install   to install python package from TestPyPi server"
+	@echo "  local-install  to install python package from local build"
 	@echo "  docs-clean     to clean the documentation directory"
 	@echo "  docs-build     to make documentation source directory"
 	@echo "  docs-html      to make standalone HTML documentation files for Github Pages"
@@ -31,19 +35,26 @@ version:
 	@echo "\t#\t\t\t\t#"
 	@echo "\t#################################\n"
 
-setup:
-	@python3 -m pip install -Ur requirements.txt
+setup: remove
+ifeq (Darwin,$(findstring Darwin, $(shell uname)))
+	@if ! [[ $(PY_VER) =~ ^3\.[6-8]\.[0-9]+.*$$ ]]; then /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" && brew install python3 ; fi;
+endif
+	@python3 -m pip install --user -U setuptools wheel
+ifeq (Darwin,$(findstring Darwin, $(shell uname)))
+	@python3 -m pip install --user pyaudio==$(PYAUDIO) || python3 -m pip install --user --global-option='build_ext' --global-option='-I/usr/local/include' --global-option='-L/usr/local/lib' pyaudio==$(PYAUDIO)
+endif
+	@python3 -m pip install --user -Ur requirements.txt
 
 remove:
 	@python3 -m pip uninstall -yr requirements.txt
 
-test: setup
+test:
 	@pytest
 
-run: setup
+run:
 	@python3 ./example/advanced.app.py
 
-clean-build: remove
+clean-build:
 	@rm -rf build/
 	@rm -rf dist/
 	@rm -rf *.egg-info
@@ -59,6 +70,7 @@ clean: clean-build
 
 build: clean test
 	@python3 setup.py sdist bdist_wheel
+	@twine check dist/*
 
 publish: build
 	@twine upload dist/*
@@ -69,10 +81,13 @@ test-publish: build
 	@make clean
 
 install: clean setup
-	@python3 -m pip install pi-clap==$(RELEASE)
+	@python3 -m pip install --user pi-clap==$(RELEASE)
 
 test-install: clean setup
-	@python3 -m pip install --index-url https://test.pypi.org/simple/ pi-clap==$(RELEASE)
+	@python3 -m pip install --user --index-url https://test.pypi.org/simple/ pi-clap==$(RELEASE)
+
+local-install: build
+	@python3 -m pip install --user dist/pi_clap-$(RELEASE)-py3-none-any.whl
 
 uninstall:
 	@python3 -m pip uninstall pi-clap

README.md

@@ -49,13 +49,13 @@ cd pi-clap
 make help # Display the possible options available
 ```
 
-Version number is pulled from `piclap/__init__.py`
+Version number is fetched from [`piclap/__init__.py`](https://github.com/nikhiljohn10/pi-clap/blob/master/piclap/__init__.py)
 
-- Package - /piclap
-- Examples - /example
-- Documentation - /docs/source
-- Test Cases - /test
-- Github Actions - /.github/workflows
+- Package - [/piclap](https://github.com/nikhiljohn10/pi-clap/tree/master/piclap)
+- Examples - [/example](https://github.com/nikhiljohn10/pi-clap/tree/master/example)
+- Documentation - [/docs/source](https://github.com/nikhiljohn10/pi-clap/tree/master/docs/source)
+- Test Cases - [/test](https://github.com/nikhiljohn10/pi-clap/tree/master/tests)
+- Github Actions - [/.github/workflows](https://github.com/nikhiljohn10/pi-clap/tree/master/.github/workflows)
 
 ### License
 

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 4f0faebcf4478dd34500f09b77e550b7
+config: 5a6c472e576ae28449e07d09da73141f
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_modules/index.html

@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Overview: module code &mdash; pi-clap 1.3.2 documentation</title>
+  <title>Overview: module code &mdash; pi-clap 1.4.1 documentation</title>
 
 
 
@@ -59,7 +59,7 @@
 
 
               <div class="version">
-                1.3
+                1.4
               </div>
 
 
@@ -86,16 +86,15 @@
 
               <p class="caption"><span class="caption-text">Contents</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
-</ul>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started.html">Getting Started</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../piclap.html">Documentation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../rpi.html">Raspberry Pi Tutorial</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../documentation.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Raspberry Pi Tutorial</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Links</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference external" href="https://magpi.raspberrypi.org/articles/raspberry-pi-clapper">Tutorial</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://magpi.raspberrypi.org/articles/raspberry-pi-clapper">MagPi Tutorial</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/pi-clap/">Python Package</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/nikhiljohn10/pi-clap">Source Code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>