Commit from build.sh

README.md

@@ -161,3 +161,5 @@ seq2gif -s 2 -i ttyrecord -w 120 -h 36 -o use.gif
 ```
 
 [ttyrec](https://aur.archlinux.org/packages/ttyrec/) and [seq2gif](https://github.com/saitoha/seq2gif)
+
+keyboard layouts were generated with http://www.keyboard-layout-editor.com/

README.rst

@@ -27,6 +27,7 @@ Versions| |Documentation Status|
       -  `In-depth installation <#in-depth-installation>`__
 
 -  `Running <#running>`__
+-  `Keybindings <#keybindings>`__
 -  `Documentation <#documentation>`__
 -  `Contributing <#contributing>`__
 
@@ -140,6 +141,68 @@ After installing just run:
 
 ``birdears --help``
 
+Keybindings
+-----------
+
+ionian (major)
+~~~~~~~~~~~~~~
+
+These are the keybindings for the **Ionian (Major) Scale**; black keys
+are the chromatic notes.
+
+.. figure:: docs/keybindings/ionian.png
+   :alt: birdears - ionian(major) keybindings
+
+   birdears - ionian(major) keybindings
+
+dorian
+~~~~~~
+
+.. figure:: docs/keybindings/dorian.png
+   :alt: birdears - dorian keybindings
+
+   birdears - dorian keybindings
+
+phrygian
+~~~~~~~~
+
+.. figure:: docs/keybindings/phrygian.png
+   :alt: birdears - phryigian keybindings
+
+   birdears - phryigian keybindings
+
+lydian
+~~~~~~
+
+.. figure:: docs/keybindings/lydian.png
+   :alt: birdears - lydian keybindings
+
+   birdears - lydian keybindings
+
+mixolydian
+~~~~~~~~~~
+
+.. figure:: docs/keybindings/mixolydian.png
+   :alt: birdears - mixolydian keybindings
+
+   birdears - mixolydian keybindings
+
+aeolian
+~~~~~~~
+
+.. figure:: docs/keybindings/minor.png
+   :alt: birdears - aeolian keybindings
+
+   birdears - aeolian keybindings
+
+locrian
+~~~~~~~
+
+.. figure:: docs/keybindings/locrian.png
+   :alt: birdears - locrian(minor) keybindings
+
+   birdears - locrian(minor) keybindings
+
 Documentation
 -------------
 
@@ -166,6 +229,9 @@ the screencast was recorded with a command similar to
 `ttyrec <https://aur.archlinux.org/packages/ttyrec/>`__ and
 `seq2gif <https://github.com/saitoha/seq2gif>`__
 
+keyboard layouts were generated with
+http://www.keyboard-layout-editor.com/
+
 .. |Maintenance| image:: https://img.shields.io/maintenance/yes/2017.svg?style=flat-square
    :target: https://github.com/iacchus/birdears/issues/new?title=Is+birdears+still+maintained&body=Please+file+an+issue+if+the+maintained+button+says+no
 .. |Travis Build Status| image:: https://img.shields.io/travis/iacchus/birdears.svg?style=flat-square&label=build

docs/coverage-html/birdears___init___py.html

@@ -429,7 +429,7 @@ <h2 class="stats">
 <p id="t144" class="pln">            <span class="str">'dorian'</span><span class="op">:</span>     <span class="str">"zsxcfvgbhnmk,SXCFVGBHNMKZ"</span><span class="op">,</span><span class="strut">&nbsp;</span></p>
 <p id="t145" class="pln">            <span class="str">'phrygian'</span><span class="op">:</span>   <span class="str">"zxdcfvgbnjmk,XDCFVGBNJMKZ"</span><span class="op">,</span><span class="strut">&nbsp;</span></p>
 <p id="t146" class="pln">            <span class="str">'lydian'</span><span class="op">:</span>     <span class="str">"zsxdcfvbhnjm,SXDCFVBHNJMZ"</span><span class="op">,</span><span class="strut">&nbsp;</span></p>
-<p id="t147" class="pln">            <span class="str">'myxolidian'</span><span class="op">:</span> <span class="str">"zsxdcvgbhnmk,SXDCVGBHNMNZ"</span><span class="op">,</span><span class="strut">&nbsp;</span></p>
+<p id="t147" class="pln">            <span class="str">'mixolydian'</span><span class="op">:</span> <span class="str">"zsxdcvgbhnmk,SXDCVGBHNMNZ"</span><span class="op">,</span><span class="strut">&nbsp;</span></p>
 <p id="t148" class="pln">            <span class="str">'minor'</span><span class="op">:</span>      <span class="str">"zsxcfvgbnjmk,SXCFVGBNJMKZ"</span><span class="op">,</span><span class="strut">&nbsp;</span></p>
 <p id="t149" class="pln">            <span class="str">'locrian'</span><span class="op">:</span>    <span class="str">"zxdcfvbhnjmk,XDCFVBHNJMKZ"</span><span class="op">,</span><span class="strut">&nbsp;</span></p>
 <p id="t150" class="pln">        <span class="op">}</span><span class="op">,</span><span class="strut">&nbsp;</span></p>
@@ -506,7 +506,7 @@ <h2 class="stats">
     <div class="content">
         <p>
             <a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v4.4.2</a>,
-            created at 2017-12-19 09:16
+            created at 2017-12-19 13:14
         </p>
     </div>
 </div>

docs/coverage-html/birdears_interfaces_commandline_py.html

@@ -8,7 +8,7 @@
 
 
     <meta http-equiv="X-UA-Compatible" content="IE=emulateIE7" />
-    <title>Coverage for birdears/interfaces/commandline.py: 99%</title>
+    <title>Coverage for birdears/interfaces/commandline.py: 100%</title>
     <link rel="stylesheet" href="style.css" type="text/css">
 
     <script type="text/javascript" src="jquery.min.js"></script>
@@ -24,15 +24,15 @@
 <div id="header">
     <div class="content">
         <h1>Coverage for <b>birdears/interfaces/commandline.py</b> :
-            <span class="pc_cov">99%</span>
+            <span class="pc_cov">100%</span>
         </h1>
 
         <img id="keyboard_icon" src="keybd_closed.png" alt="Show keyboard shortcuts" />
 
         <h2 class="stats">
             119 statements &nbsp;
-            <span class="run hide_run shortkey_r button_toggle_run">118 run</span>
-            <span class="mis shortkey_m button_toggle_mis">1 missing</span>
+            <span class="run hide_run shortkey_r button_toggle_run">119 run</span>
+            <span class="mis shortkey_m button_toggle_mis">0 missing</span>
             <span class="exc shortkey_x button_toggle_exc">0 excluded</span>
 
 
@@ -132,7 +132,7 @@ <h2 class="stats">
 <p id="n63" class="pln"><a href="#n63">63</a></p>
 <p id="n64" class="pln"><a href="#n64">64</a></p>
 <p id="n65" class="stm run hide_run"><a href="#n65">65</a></p>
-<p id="n66" class="stm mis"><a href="#n66">66</a></p>
+<p id="n66" class="stm run hide_run"><a href="#n66">66</a></p>
 <p id="n67" class="pln"><a href="#n67">67</a></p>
 <p id="n68" class="stm run hide_run"><a href="#n68">68</a></p>
 <p id="n69" class="pln"><a href="#n69">69</a></p>
@@ -399,7 +399,7 @@ <h2 class="stats">
 <p id="t63" class="pln"><span class="strut">&nbsp;</span></p>
 <p id="t64" class="pln">    <span class="com"># TODO: make a class for response</span><span class="strut">&nbsp;</span></p>
 <p id="t65" class="stm run hide_run">    <span class="key">if</span> <span class="nam">response</span><span class="op">[</span><span class="str">'is_correct'</span><span class="op">]</span><span class="op">:</span><span class="strut">&nbsp;</span></p>
-<p id="t66" class="stm mis">        <span class="nam">response_text</span> <span class="op">=</span> <span class="str">"Correct!"</span><span class="strut">&nbsp;</span></p>
+<p id="t66" class="stm run hide_run">        <span class="nam">response_text</span> <span class="op">=</span> <span class="str">"Correct!"</span><span class="strut">&nbsp;</span></p>
 <p id="t67" class="pln">    <span class="key">else</span><span class="op">:</span><span class="strut">&nbsp;</span></p>
 <p id="t68" class="stm run hide_run">        <span class="nam">response_text</span> <span class="op">=</span> <span class="str">"Wrong.."</span><span class="strut">&nbsp;</span></p>
 <p id="t69" class="pln"><span class="strut">&nbsp;</span></p>
@@ -608,7 +608,7 @@ <h2 class="stats">
     <div class="content">
         <p>
             <a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v4.4.2</a>,
-            created at 2017-12-12 17:36
+            created at 2017-12-19 13:14
         </p>
     </div>
 </div>

docs/coverage-html/index.html

@@ -66,10 +66,10 @@ <h1>Coverage report:
             <tr class="total">
                 <td class="name left">Total</td>
                 <td>1010</td>
-                <td>108</td>
+                <td>107</td>
                 <td>0</td>
 
-                <td class="right" data-ratio="902 1010">89%</td>
+                <td class="right" data-ratio="903 1010">89%</td>
             </tr>
         </tfoot>
         <tbody>
@@ -104,10 +104,10 @@ <h1>Coverage report:
             <tr class="file">
                 <td class="name left"><a href="birdears_interfaces_commandline_py.html">birdears/interfaces/commandline.py</a></td>
                 <td>119</td>
-                <td>1</td>
+                <td>0</td>
                 <td>0</td>
 
-                <td class="right" data-ratio="118 119">99%</td>
+                <td class="right" data-ratio="119 119">100%</td>
             </tr>
 
             <tr class="file">
@@ -230,7 +230,7 @@ <h1>Coverage report:
     <div class="content">
         <p>
             <a class="nav" href="https://coverage.readthedocs.io">coverage.py v4.4.2</a>,
-            created at 2017-12-19 09:16
+            created at 2017-12-19 13:14
         </p>
     </div>
 </div>

docs/coverage-html/status.json

@@ -1 +1 @@
-{"format":1,"version":"4.4.2","settings":"de9b115d53f2204b2a545b76729d37bc","files":{"birdears___init___py":{"hash":"ac67c506aa3c93d566b088ee43292d8c","index":{"nums":[1,40,0,12,0,0,0],"html_filename":"birdears___init___py.html","relative_filename":"birdears/__init__.py"}},"birdears___main___py":{"hash":"9d1b25d73030834e1345a4a54d92ed1d","index":{"nums":[1,98,0,9,0,0,0],"html_filename":"birdears___main___py.html","relative_filename":"birdears/__main__.py"}},"birdears_interfaces___init___py":{"hash":"182b2dca469bf063cbcf996d517b03da","index":{"nums":[1,0,0,0,0,0,0],"html_filename":"birdears_interfaces___init___py.html","relative_filename":"birdears/interfaces/__init__.py"}},"birdears_interfaces_commandline_py":{"hash":"95757c33e741ff8883287aa29ba375eb","index":{"nums":[1,119,0,1,0,0,0],"html_filename":"birdears_interfaces_commandline_py.html","relative_filename":"birdears/interfaces/commandline.py"}},"birdears_interval_py":{"hash":"b9b38e739e873f5ac75bba0aaece2196","index":{"nums":[1,91,0,13,0,0,0],"html_filename":"birdears_interval_py.html","relative_filename":"birdears/interval.py"}},"birdears_logger_py":{"hash":"dc0b4a7de4e2ae3ef899ed95a07983b6","index":{"nums":[1,25,0,6,0,0,0],"html_filename":"birdears_logger_py.html","relative_filename":"birdears/logger.py"}},"birdears_prequestion_py":{"hash":"cff52086d06049eb9408f50b3262cd48","index":{"nums":[1,38,0,1,0,0,0],"html_filename":"birdears_prequestion_py.html","relative_filename":"birdears/prequestion.py"}},"birdears_questionbase_py":{"hash":"c71c5bd0dc7fd1ae4cae985cf7d4311b","index":{"nums":[1,95,0,37,0,0,0],"html_filename":"birdears_questionbase_py.html","relative_filename":"birdears/questionbase.py"}},"birdears_questions___init___py":{"hash":"514b385970a8471b70dadb27b7b75b8c","index":{"nums":[1,1,0,0,0,0,0],"html_filename":"birdears_questions___init___py.html","relative_filename":"birdears/questions/__init__.py"}},"birdears_questions_harmonicinterval_py":{"hash":"a404389784789ae10aa05252663d9dad","index":{"nums":[1,54,0,0,0,0,0],"html_filename":"birdears_questions_harmonicinterval_py.html","relative_filename":"birdears/questions/harmonicinterval.py"}},"birdears_questions_instrumentaldictation_py":{"hash":"ef7e2558e67f3ee93e432fe6759956b3","index":{"nums":[1,55,0,0,0,0,0],"html_filename":"birdears_questions_instrumentaldictation_py.html","relative_filename":"birdears/questions/instrumentaldictation.py"}},"birdears_questions_melodicdictation_py":{"hash":"f4a4e554c4936c4ad4005343181ae8d5","index":{"nums":[1,61,0,0,0,0,0],"html_filename":"birdears_questions_melodicdictation_py.html","relative_filename":"birdears/questions/melodicdictation.py"}},"birdears_questions_melodicinterval_py":{"hash":"8d60e76e2e806834eadd48b7c9d07ff6","index":{"nums":[1,55,0,0,0,0,0],"html_filename":"birdears_questions_melodicinterval_py.html","relative_filename":"birdears/questions/melodicinterval.py"}},"birdears_resolution_py":{"hash":"da4564b58be9d32e2e5bcce4f02fcc13","index":{"nums":[1,68,0,1,0,0,0],"html_filename":"birdears_resolution_py.html","relative_filename":"birdears/resolution.py"}},"birdears_scale_py":{"hash":"e552d849a4919776b43120167c312729","index":{"nums":[1,110,0,1,0,0,0],"html_filename":"birdears_scale_py.html","relative_filename":"birdears/scale.py"}},"birdears_sequence_py":{"hash":"ab909f21bcf48f06250bb2c1547c2fbd","index":{"nums":[1,100,0,27,0,0,0],"html_filename":"birdears_sequence_py.html","relative_filename":"birdears/sequence.py"}}}}
+{"format":1,"version":"4.4.2","settings":"de9b115d53f2204b2a545b76729d37bc","files":{"birdears___init___py":{"hash":"e6ab7d935c6c93e10f61fc07ea6574e8","index":{"nums":[1,40,0,12,0,0,0],"html_filename":"birdears___init___py.html","relative_filename":"birdears/__init__.py"}},"birdears___main___py":{"hash":"9d1b25d73030834e1345a4a54d92ed1d","index":{"nums":[1,98,0,9,0,0,0],"html_filename":"birdears___main___py.html","relative_filename":"birdears/__main__.py"}},"birdears_interfaces___init___py":{"hash":"182b2dca469bf063cbcf996d517b03da","index":{"nums":[1,0,0,0,0,0,0],"html_filename":"birdears_interfaces___init___py.html","relative_filename":"birdears/interfaces/__init__.py"}},"birdears_interfaces_commandline_py":{"hash":"fc8a9d2bc20b3ec8a0571c9170567f37","index":{"nums":[1,119,0,0,0,0,0],"html_filename":"birdears_interfaces_commandline_py.html","relative_filename":"birdears/interfaces/commandline.py"}},"birdears_interval_py":{"hash":"b9b38e739e873f5ac75bba0aaece2196","index":{"nums":[1,91,0,13,0,0,0],"html_filename":"birdears_interval_py.html","relative_filename":"birdears/interval.py"}},"birdears_logger_py":{"hash":"dc0b4a7de4e2ae3ef899ed95a07983b6","index":{"nums":[1,25,0,6,0,0,0],"html_filename":"birdears_logger_py.html","relative_filename":"birdears/logger.py"}},"birdears_prequestion_py":{"hash":"cff52086d06049eb9408f50b3262cd48","index":{"nums":[1,38,0,1,0,0,0],"html_filename":"birdears_prequestion_py.html","relative_filename":"birdears/prequestion.py"}},"birdears_questionbase_py":{"hash":"c71c5bd0dc7fd1ae4cae985cf7d4311b","index":{"nums":[1,95,0,37,0,0,0],"html_filename":"birdears_questionbase_py.html","relative_filename":"birdears/questionbase.py"}},"birdears_questions___init___py":{"hash":"514b385970a8471b70dadb27b7b75b8c","index":{"nums":[1,1,0,0,0,0,0],"html_filename":"birdears_questions___init___py.html","relative_filename":"birdears/questions/__init__.py"}},"birdears_questions_harmonicinterval_py":{"hash":"a404389784789ae10aa05252663d9dad","index":{"nums":[1,54,0,0,0,0,0],"html_filename":"birdears_questions_harmonicinterval_py.html","relative_filename":"birdears/questions/harmonicinterval.py"}},"birdears_questions_instrumentaldictation_py":{"hash":"ef7e2558e67f3ee93e432fe6759956b3","index":{"nums":[1,55,0,0,0,0,0],"html_filename":"birdears_questions_instrumentaldictation_py.html","relative_filename":"birdears/questions/instrumentaldictation.py"}},"birdears_questions_melodicdictation_py":{"hash":"f4a4e554c4936c4ad4005343181ae8d5","index":{"nums":[1,61,0,0,0,0,0],"html_filename":"birdears_questions_melodicdictation_py.html","relative_filename":"birdears/questions/melodicdictation.py"}},"birdears_questions_melodicinterval_py":{"hash":"8d60e76e2e806834eadd48b7c9d07ff6","index":{"nums":[1,55,0,0,0,0,0],"html_filename":"birdears_questions_melodicinterval_py.html","relative_filename":"birdears/questions/melodicinterval.py"}},"birdears_resolution_py":{"hash":"da4564b58be9d32e2e5bcce4f02fcc13","index":{"nums":[1,68,0,1,0,0,0],"html_filename":"birdears_resolution_py.html","relative_filename":"birdears/resolution.py"}},"birdears_scale_py":{"hash":"e552d849a4919776b43120167c312729","index":{"nums":[1,110,0,1,0,0,0],"html_filename":"birdears_scale_py.html","relative_filename":"birdears/scale.py"}},"birdears_sequence_py":{"hash":"ab909f21bcf48f06250bb2c1547c2fbd","index":{"nums":[1,100,0,27,0,0,0],"html_filename":"birdears_sequence_py.html","relative_filename":"birdears/sequence.py"}}}}

docs/sphinx/_build/html/.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: ec46f853ce0be3a37020e296fdea819e
+config: a9cbe7b1026c9c64fd6a55d48c8a069c
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/sphinx/_build/html/_modules/birdears/interfaces/commandline.html

@@ -5,13 +5,13 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>birdears.interfaces.commandline &#8212; birdears 0.1.2 documentation</title>
+    <title>birdears.interfaces.commandline &#8212; birdears 0.1.3 documentation</title>
     <link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../../',
-        VERSION:     '0.1.2',
+        VERSION:     '0.1.3',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,

docs/sphinx/_build/html/_modules/birdears/interval.html

@@ -5,13 +5,13 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>birdears.interval &#8212; birdears 0.1.2 documentation</title>
+    <title>birdears.interval &#8212; birdears 0.1.3 documentation</title>
     <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '0.1.2',
+        VERSION:     '0.1.3',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,

docs/sphinx/_build/html/_modules/birdears/logger.html

@@ -5,13 +5,13 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>birdears.logger &#8212; birdears 0.1.2 documentation</title>
+    <title>birdears.logger &#8212; birdears 0.1.3 documentation</title>
     <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '0.1.2',
+        VERSION:     '0.1.3',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,

docs/sphinx/_build/html/_modules/birdears/prequestion.html

@@ -5,13 +5,13 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>birdears.prequestion &#8212; birdears 0.1.2 documentation</title>
+    <title>birdears.prequestion &#8212; birdears 0.1.3 documentation</title>
     <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '0.1.2',
+        VERSION:     '0.1.3',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,

docs/sphinx/_build/html/_modules/birdears/questionbase.html

@@ -5,13 +5,13 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>birdears.questionbase &#8212; birdears 0.1.2 documentation</title>
+    <title>birdears.questionbase &#8212; birdears 0.1.3 documentation</title>
     <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '0.1.2',
+        VERSION:     '0.1.3',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,