Merge branch 'version-0.4.0' of github.com:PedalPi/Application into v…

…ersion-0.4.0

.travis.yml

@@ -9,14 +9,23 @@ python:
 
 sudo: required
 
+jobs:
+  include:
+    - stage: doc
+      script:
+        - make install-docs-requirements
+        - make docs
+
 install:
+  - make
   - sudo apt-get install -y portaudio19-dev python-all-dev --no-install-recommends
   - sudo apt-get install -y lilv-utils calf-plugins guitarix --no-install-recommends
-  - pip3 install coveralls
+  - pip3 install -U setuptools
+  - make install-tests-requirements
 
 script:
   - pip3 install .
-  - coverage3 run --source=application setup.py test
+  - make test
 
 after_success:
   - bash <(curl -s https://codecov.io/bash)

CHANGES

@@ -1,29 +1,60 @@
+Version 0.4.0 - released 02/18/18
+*********************************
+
+ - `Issue #55`_ - Fix bank uuid/name
+ - `Issue #58`_ - Support v0.6.0: Add connection type (audio or midi) in default bank
+ - `Issue #60`_ - Add makefile
+ - `Issue #46`_ - Add changelog in docs
+
+.. _Issue #55: https://github.com/PedalPi/Application/issues/55
+.. _Issue #58: https://github.com/PedalPi/Application/issues/58
+.. _Issue #60: https://github.com/PedalPi/Application/issues/60
+.. _Issue #46: https://github.com/PedalPi/Application/issues/46
+
 Version 0.3.0 - released 05/30/17
-=================================
- - Issue #29 - Secure components close
- - Issue #30 - Replace print log to logging
- - **Breaking change**: Issues #39 and #5 - Change save method to pluginsmanager (v0.5.0) Autosaver
+*********************************
+
+ - `Issue #29`_ - Secure components close
+ - `Issue #30`_ - Replace print log to logging
+ - **Breaking change**: Issues `#39`_ and `#5`_ - Change save method to pluginsmanager (v0.5.0) Autosaver
+
    - Removed BanksDao -> Using now pluginsmanager Autosaver
    - Removed Database -> Using now pluginsmanager Persistence
    - BanksController, PedalboardController, EffectController, ParamController,
      CurrentController changes your API
- - Issue #41 - Allows current pedalboard is None
- - Issue #40 - If current pedalboard index file is wrong, Application now starts
+
+ - `Issue #41`_ - Allows current pedalboard is None
+ - `Issue #40`_ - If current pedalboard index file is wrong, Application now starts
    with the current pedalboard = None
- - Issue #11 - Banks with same name not will be replaced when Application initialize
- - Issue #17 - Fixes: Remove bank with current pedalboard will be crash (when reload Application)
- - Issue #45 - Add plugins manager v0.5.0 support
+ - `Issue #11`_ - Banks with same name not will be replaced when Application initialize
+ - `Issue #17`_ - Fixes: Remove bank with current pedalboard will be crash (when reload Application)
+ - `Issue #45`_ - Add plugins manager v0.5.0 support
 
    - Removed BanksController, PedalboardController, EffectController, ParamController, NotificationController
    - Implemented :meth:`.Application.register_observer`, :meth:`.Application.unregister_observer`
 
+.. _Issue #29: https://github.com/PedalPi/Application/issues/29
+.. _Issue #30: https://github.com/PedalPi/Application/issues/30
+.. _#39: https://github.com/PedalPi/Application/issues/39
+.. _#5: https://github.com/PedalPi/Application/issues/5
+.. _Issue #41: https://github.com/PedalPi/Application/issues/41
+.. _Issue #40: https://github.com/PedalPi/Application/issues/40
+.. _Issue #11: https://github.com/PedalPi/Application/issues/11
+.. _Issue #17: https://github.com/PedalPi/Application/issues/17
+.. _Issue #45: https://github.com/PedalPi/Application/issues/45
 
 Version 0.2.1 - released 04/14/17
-=================================
- - 21fdb32 Issue #30 - Fix move pedalboard notification
+*********************************
+
+ - `21fdb32`_ Issue `#30`_ - Fix move pedalboard notification
  - Fix Readme: Pipy render README.rst
- - fbb9908 - Add Licenses in __init__.py files
+ - `fbb9908`_ - Add Licenses in __init__.py files
+
+.. _21fdb32: https://github.com/PedalPi/Application/commit/21fdb32
+.. _#30: https://github.com/PedalPi/Application/issues/30
+.. _fbb9908: https://github.com/PedalPi/Application/commit/fbb9908
 
 Version 0.2.0 - released 04/05/17
-=================================
+*********************************
+
  - Initial release

application/data/banks/9f0cd4fa-8fc8-48a4-9513-056aba8fd841.json

@@ -0,0 +1 @@
+{"name": "Bank 1", "pedalboards": [{"name": "Pedalboard 1", "connections": [{"type": "audio", "input": {"index": 0, "symbol": "in_l", "effect": 0}, "output": {"symbol": "capture_1", "index": 0}}, {"type": "audio", "input": {"index": 0, "symbol": "in_l", "effect": 1}, "output": {"index": 2, "symbol": "out_l", "effect": 0}}, {"type": "audio", "input": {"symbol": "playback_1", "index": 0}, "output": {"index": 2, "symbol": "out_l", "effect": 1}}, {"type": "audio", "input": {"symbol": "playback_2", "index": 1}, "output": {"index": 2, "symbol": "out_l", "effect": 1}}], "data": {}, "effects": [{"active": true, "plugin": "http://calf.sourceforge.net/plugins/Flanger", "technology": "lv2", "version": "0.60", "params": [{"value": 0.10000000149011612, "symbol": "min_delay", "index": 4}, {"value": 1.0, "symbol": "mod_depth", "index": 5}, {"value": 0.20000000298023224, "symbol": "mod_rate", "index": 6}, {"value": 0.8999999761581421, "symbol": "feedback", "index": 7}, {"value": 90.0, "symbol": "stereo", "index": 8}, {"value": 0.0, "symbol": "reset", "index": 9}, {"value": 1.0, "symbol": "amount", "index": 10}, {"value": 1.0, "symbol": "dry", "index": 11}]}, {"active": true, "plugin": "http://calf.sourceforge.net/plugins/Reverb", "technology": "lv2", "version": "0.0", "params": [{"value": 1.5, "symbol": "decay_time", "index": 7}, {"value": 5000.0, "symbol": "hf_damp", "index": 8}, {"value": 2, "symbol": "room_size", "index": 9}, {"value": 0.5, "symbol": "diffusion", "index": 10}, {"value": 0.25, "symbol": "amount", "index": 11}, {"value": 1.0, "symbol": "dry", "index": 12}, {"value": 0.0, "symbol": "predelay", "index": 13}, {"value": 300.0, "symbol": "bass_cut", "index": 14}, {"value": 5000.0, "symbol": "treble_cut", "index": 15}]}]}, {"name": "Bypass", "connections": [{"type": "audio", "input": {"symbol": "playback_1", "index": 0}, "output": {"symbol": "capture_1", "index": 0}}], "data": {}, "effects": []}], "index": 0}

docs/source/changelog.rst

@@ -0,0 +1,4 @@
+Changelog
+=========
+
+.. include:: ../../CHANGES

docs/source/conf.py

@@ -22,7 +22,7 @@
 #sys.path.insert(0, os.path.abspath('.'))
 
 sys.path.insert(0, os.path.join(os.path.dirname(__file__), '../..'))
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+on_rtd = True#os.environ.get('READTHEDOCS', None) == 'True'
 
 # -- General configuration ------------------------------------------------
 
@@ -63,7 +63,7 @@
 
 # General information about the project.
 project = 'PedalPi - Application'
-copyright = '2016, SrMouraSilva'
+copyright = '2018, SrMouraSilva'
 author = 'SrMouraSilva'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -354,4 +354,6 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {
+    'https://docs.python.org/3/': None
+}

docs/source/index.rst

@@ -1,5 +1,13 @@
 .. include:: ../../README.rst
 
+Changelog
+---------
+
+.. toctree::
+   :maxdepth: 2
+
+   changelog
+
 API
 ---
 

makefile

@@ -0,0 +1,86 @@
+BROWSER=firefox
+BOLD=\033[1m
+NORMAL=\033[0m
+
+default: help
+
+clean: clean-pyc clean-test clean-build clean-docs
+
+clean-build:
+	rm -rf .eggs
+	rm -rf build
+	rm -rf dist
+
+clean-pyc:
+	find . -name '*.pyc' -exec rm --force {} +
+	find . -name '*.pyo' -exec rm --force {} +
+
+clean-test:
+	rm -rf .cache
+	rm -f .coverage
+	rm -rf htmlcov
+	rm -rf test/data
+
+clean-docs:
+	rm -rf docs/build
+
+docs: clean-docs
+	cd docs && $(MAKE) html
+
+docs-see: docs
+	$(BROWSER) docs/build/html/index.html
+
+install-docs-requirements:
+	pip3 install sphinx
+	pip3 install sphinx_rtd_theme
+
+install-tests-requirements:
+	pip3 install coveralls
+	pip3 install pytest pytest-cov
+
+run:
+	@echo "Run option isn't created =)"
+
+test: clean-test
+	pytest --cov=application
+
+test-docs:
+	@echo "Not implemented"
+	#python -m doctest *.rst -v
+	#python -m doctest docs/*/*.rst -v
+
+test-details: test
+	coverage3 html
+	$(BROWSER) htmlcov/index.html
+
+help: cabecalho
+	@echo ""
+	@echo "Commands"
+	@echo "    $(BOLD)clean$(NORMAL)"
+	@echo "          Clean files"
+	@echo "    $(BOLD)docs$(NORMAL)"
+	@echo "          Make the docs"
+	@echo "    $(BOLD)docs-see$(NORMAL)"
+	@echo "          Make the docs and open it in BROWSER"
+	@echo "    $(BOLD)install-docs-requirements$(NORMAL)"
+	@echo "          Install the docs requirements"
+	@echo "    $(BOLD)install-tests-requirements$(NORMAL)"
+	@echo "          Install the tests requirements"
+	@echo "    $(BOLD)test$(NORMAL)"
+	@echo "          Execute the tests"
+	@echo "    $(BOLD)test-details$(NORMAL)"
+	@echo "          Execute the tests and shows the result in BROWSER"
+	@echo "           - BROWSER=firefox"
+	@echo "    $(BOLD)help$(NORMAL)"
+	@echo "          Show the valid commands"
+
+cabecalho:
+	@echo "$(BOLD)                      _ _            _   _"
+	@echo "$     /\               | (_)          | | (_)            "
+	@echo "$    /  \   _ __  _ __ | |_  ___  __ _| |_ _  ___  _ __  "
+	@echo "$   / /\ \ | '_ \| '_ \| | |/ __|/ _\` | __| |/ _ \| '_ \ "
+	@echo "$  / ____ \| |_) | |_) | | | (__| (_| | |_| | (_) | | | |"
+	@echo "$ /_/    \_\ .__/| .__/|_|_|\___|\__,_|\__|_|\___/|_| |_|"
+	@echo "$          | |   | |                                     "
+	@echo "$          |_|   |_|                                     "
+	@echo "Link$(NORMAL): https://pypi.org/project/PedalPi-Application/"