Skip to content

Commit

Permalink
pypi didn't like that
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathangjertsen committed Jul 27, 2022
1 parent d7f08b3 commit afffce0
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 41 deletions.
8 changes: 0 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ Installation with dependencies for reading and writing MIDI/XLSX/PDF files:
Convert between formats
=======================

.. highlight:: none

If you just want the converter functionality, invoke `jchord` on the command line::

usage: jchord [-h] [--midi MIDI] [--pdf PDF] file_in file_out
Expand All @@ -48,17 +46,13 @@ If you just want the converter functionality, invoke `jchord` on the command lin
--midi MIDI comma separated list of arguments for midi, e.g. tempo=8,beats_per_chord=2
--pdf PDF comma separated list of arguments for pdf, e.g. chords_per_row=8,fontsize=30

.. highlight:: bash

Example::

jchord "Cm A E7 F#m7" example.mid --midi tempo=80,beats_per_chord=1

As a library
============

.. highlight:: python

Here is an example that parses a chord progression written as a string, transposes it upwards by 2 semitones,
converts it back to a string and then creates a midi file from it.::

Expand All @@ -69,8 +63,6 @@ converts it back to a string and then creates a midi file from it.::
print(prog.to_string())
prog.to_midi(MidiConversionSettings(filename="example.midi", tempo=100, beats_per_chord=2, instrument=4))

.. highlight:: none

Output::

D -- Gm7 --
Expand Down
2 changes: 1 addition & 1 deletion VERSION.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.1.0
3.1.1
32 changes: 16 additions & 16 deletions docs/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,42 +63,42 @@ <h1>Get it<a class="headerlink" href="#get-it" title="Permalink to this heading"
<section id="convert-between-formats">
<h1>Convert between formats<a class="headerlink" href="#convert-between-formats" title="Permalink to this heading"></a></h1>
<p>If you just want the converter functionality, invoke <cite>jchord</cite> on the command line:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>usage: jchord [-h] [--midi MIDI] [--pdf PDF] file_in file_out
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">jchord</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">midi</span> <span class="n">MIDI</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">pdf</span> <span class="n">PDF</span><span class="p">]</span> <span class="n">file_in</span> <span class="n">file_out</span>

Converts between different representations of the same format
<span class="n">Converts</span> <span class="n">between</span> <span class="n">different</span> <span class="n">representations</span> <span class="n">of</span> <span class="n">the</span> <span class="n">same</span> <span class="nb">format</span>

positional arguments:
file_in Input progression as string, .txt, .xlsx or .midi
file_out Output file as .txt, .xlsx, .midi or .pdf
<span class="n">positional</span> <span class="n">arguments</span><span class="p">:</span>
<span class="n">file_in</span> <span class="n">Input</span> <span class="n">progression</span> <span class="k">as</span> <span class="n">string</span><span class="p">,</span> <span class="o">.</span><span class="n">txt</span><span class="p">,</span> <span class="o">.</span><span class="n">xlsx</span> <span class="ow">or</span> <span class="o">.</span><span class="n">midi</span>
<span class="n">file_out</span> <span class="n">Output</span> <span class="n">file</span> <span class="k">as</span> <span class="o">.</span><span class="n">txt</span><span class="p">,</span> <span class="o">.</span><span class="n">xlsx</span><span class="p">,</span> <span class="o">.</span><span class="n">midi</span> <span class="ow">or</span> <span class="o">.</span><span class="n">pdf</span>

optional arguments:
-h, --help show this help message and exit
--midi MIDI comma separated list of arguments for midi, e.g. tempo=8,beats_per_chord=2
--pdf PDF comma separated list of arguments for pdf, e.g. chords_per_row=8,fontsize=30
<span class="n">optional</span> <span class="n">arguments</span><span class="p">:</span>
<span class="o">-</span><span class="n">h</span><span class="p">,</span> <span class="o">--</span><span class="n">help</span> <span class="n">show</span> <span class="n">this</span> <span class="n">help</span> <span class="n">message</span> <span class="ow">and</span> <span class="n">exit</span>
<span class="o">--</span><span class="n">midi</span> <span class="n">MIDI</span> <span class="n">comma</span> <span class="n">separated</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">arguments</span> <span class="k">for</span> <span class="n">midi</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span> <span class="n">tempo</span><span class="o">=</span><span class="mi">8</span><span class="p">,</span><span class="n">beats_per_chord</span><span class="o">=</span><span class="mi">2</span>
<span class="o">--</span><span class="n">pdf</span> <span class="n">PDF</span> <span class="n">comma</span> <span class="n">separated</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">arguments</span> <span class="k">for</span> <span class="n">pdf</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span> <span class="n">chords_per_row</span><span class="o">=</span><span class="mi">8</span><span class="p">,</span><span class="n">fontsize</span><span class="o">=</span><span class="mi">30</span>
</pre></div>
</div>
<p>Example:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>jchord <span class="s2">&quot;Cm A E7 F#m7&quot;</span> example.mid --midi <span class="nv">tempo</span><span class="o">=</span><span class="m">80</span>,beats_per_chord<span class="o">=</span><span class="m">1</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">jchord</span> <span class="s2">&quot;Cm A E7 F#m7&quot;</span> <span class="n">example</span><span class="o">.</span><span class="n">mid</span> <span class="o">--</span><span class="n">midi</span> <span class="n">tempo</span><span class="o">=</span><span class="mi">80</span><span class="p">,</span><span class="n">beats_per_chord</span><span class="o">=</span><span class="mi">1</span>
</pre></div>
</div>
</section>
<section id="as-a-library">
<h1>As a library<a class="headerlink" href="#as-a-library" title="Permalink to this heading"></a></h1>
<p>Here is an example that parses a chord progression written as a string, transposes it upwards by 2 semitones,
converts it back to a string and then creates a midi file from it.:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">jchord</span> <span class="kn">import</span> <span class="n">ChordProgression</span><span class="p">,</span> <span class="n">MidiConversionSettings</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">jchord</span> <span class="kn">import</span> <span class="n">ChordProgression</span><span class="p">,</span> <span class="n">MidiConversionSettings</span>
<span class="n">prog</span> <span class="o">=</span> <span class="n">ChordProgression</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="s2">&quot;C -- Fm7 -- C -- G7 -- C -- E7 Am F Bm7b5 E7 Am9 F Bo C69 --&quot;</span><span class="p">)</span>
<span class="n">prog</span> <span class="o">=</span> <span class="n">prog</span><span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="o">+</span><span class="mi">2</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">prog</span><span class="o">.</span><span class="n">to_string</span><span class="p">())</span>
<span class="n">prog</span><span class="o">.</span><span class="n">to_midi</span><span class="p">(</span><span class="n">MidiConversionSettings</span><span class="p">(</span><span class="n">filename</span><span class="o">=</span><span class="s2">&quot;example.midi&quot;</span><span class="p">,</span> <span class="n">tempo</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">beats_per_chord</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">instrument</span><span class="o">=</span><span class="mi">4</span><span class="p">))</span>
</pre></div>
</div>
<p>Output:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>D -- Gm7 --
D -- A7 --
D -- F#7 Bm
G C#m7b5 F#7 Bm9
G C#o D69 --
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">D</span> <span class="o">--</span> <span class="n">Gm7</span> <span class="o">--</span>
<span class="n">D</span> <span class="o">--</span> <span class="n">A7</span> <span class="o">--</span>
<span class="n">D</span> <span class="o">--</span> <span class="n">F</span><span class="c1">#7 Bm</span>
<span class="n">G</span> <span class="n">C</span><span class="c1">#m7b5 F#7 Bm9</span>
<span class="n">G</span> <span class="n">C</span><span class="c1">#o D69 --</span>
</pre></div>
</div>
<p>For more examples, see the <a class="reference external" href="https://jonathangjertsen.github.io/jchord/#examples">documentation</a>.</p>
Expand Down
32 changes: 16 additions & 16 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,42 +65,42 @@ <h1>Get it<a class="headerlink" href="#get-it" title="Permalink to this heading"
<section id="convert-between-formats">
<h1>Convert between formats<a class="headerlink" href="#convert-between-formats" title="Permalink to this heading"></a></h1>
<p>If you just want the converter functionality, invoke <cite>jchord</cite> on the command line:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>usage: jchord [-h] [--midi MIDI] [--pdf PDF] file_in file_out
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">jchord</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">midi</span> <span class="n">MIDI</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">pdf</span> <span class="n">PDF</span><span class="p">]</span> <span class="n">file_in</span> <span class="n">file_out</span>

Converts between different representations of the same format
<span class="n">Converts</span> <span class="n">between</span> <span class="n">different</span> <span class="n">representations</span> <span class="n">of</span> <span class="n">the</span> <span class="n">same</span> <span class="nb">format</span>

positional arguments:
file_in Input progression as string, .txt, .xlsx or .midi
file_out Output file as .txt, .xlsx, .midi or .pdf
<span class="n">positional</span> <span class="n">arguments</span><span class="p">:</span>
<span class="n">file_in</span> <span class="n">Input</span> <span class="n">progression</span> <span class="k">as</span> <span class="n">string</span><span class="p">,</span> <span class="o">.</span><span class="n">txt</span><span class="p">,</span> <span class="o">.</span><span class="n">xlsx</span> <span class="ow">or</span> <span class="o">.</span><span class="n">midi</span>
<span class="n">file_out</span> <span class="n">Output</span> <span class="n">file</span> <span class="k">as</span> <span class="o">.</span><span class="n">txt</span><span class="p">,</span> <span class="o">.</span><span class="n">xlsx</span><span class="p">,</span> <span class="o">.</span><span class="n">midi</span> <span class="ow">or</span> <span class="o">.</span><span class="n">pdf</span>

optional arguments:
-h, --help show this help message and exit
--midi MIDI comma separated list of arguments for midi, e.g. tempo=8,beats_per_chord=2
--pdf PDF comma separated list of arguments for pdf, e.g. chords_per_row=8,fontsize=30
<span class="n">optional</span> <span class="n">arguments</span><span class="p">:</span>
<span class="o">-</span><span class="n">h</span><span class="p">,</span> <span class="o">--</span><span class="n">help</span> <span class="n">show</span> <span class="n">this</span> <span class="n">help</span> <span class="n">message</span> <span class="ow">and</span> <span class="n">exit</span>
<span class="o">--</span><span class="n">midi</span> <span class="n">MIDI</span> <span class="n">comma</span> <span class="n">separated</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">arguments</span> <span class="k">for</span> <span class="n">midi</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span> <span class="n">tempo</span><span class="o">=</span><span class="mi">8</span><span class="p">,</span><span class="n">beats_per_chord</span><span class="o">=</span><span class="mi">2</span>
<span class="o">--</span><span class="n">pdf</span> <span class="n">PDF</span> <span class="n">comma</span> <span class="n">separated</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">arguments</span> <span class="k">for</span> <span class="n">pdf</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span> <span class="n">chords_per_row</span><span class="o">=</span><span class="mi">8</span><span class="p">,</span><span class="n">fontsize</span><span class="o">=</span><span class="mi">30</span>
</pre></div>
</div>
<p>Example:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>jchord <span class="s2">&quot;Cm A E7 F#m7&quot;</span> example.mid --midi <span class="nv">tempo</span><span class="o">=</span><span class="m">80</span>,beats_per_chord<span class="o">=</span><span class="m">1</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">jchord</span> <span class="s2">&quot;Cm A E7 F#m7&quot;</span> <span class="n">example</span><span class="o">.</span><span class="n">mid</span> <span class="o">--</span><span class="n">midi</span> <span class="n">tempo</span><span class="o">=</span><span class="mi">80</span><span class="p">,</span><span class="n">beats_per_chord</span><span class="o">=</span><span class="mi">1</span>
</pre></div>
</div>
</section>
<section id="as-a-library">
<h1>As a library<a class="headerlink" href="#as-a-library" title="Permalink to this heading"></a></h1>
<p>Here is an example that parses a chord progression written as a string, transposes it upwards by 2 semitones,
converts it back to a string and then creates a midi file from it.:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">jchord</span> <span class="kn">import</span> <span class="n">ChordProgression</span><span class="p">,</span> <span class="n">MidiConversionSettings</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">jchord</span> <span class="kn">import</span> <span class="n">ChordProgression</span><span class="p">,</span> <span class="n">MidiConversionSettings</span>
<span class="n">prog</span> <span class="o">=</span> <span class="n">ChordProgression</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="s2">&quot;C -- Fm7 -- C -- G7 -- C -- E7 Am F Bm7b5 E7 Am9 F Bo C69 --&quot;</span><span class="p">)</span>
<span class="n">prog</span> <span class="o">=</span> <span class="n">prog</span><span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="o">+</span><span class="mi">2</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">prog</span><span class="o">.</span><span class="n">to_string</span><span class="p">())</span>
<span class="n">prog</span><span class="o">.</span><span class="n">to_midi</span><span class="p">(</span><span class="n">MidiConversionSettings</span><span class="p">(</span><span class="n">filename</span><span class="o">=</span><span class="s2">&quot;example.midi&quot;</span><span class="p">,</span> <span class="n">tempo</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">beats_per_chord</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">instrument</span><span class="o">=</span><span class="mi">4</span><span class="p">))</span>
</pre></div>
</div>
<p>Output:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>D -- Gm7 --
D -- A7 --
D -- F#7 Bm
G C#m7b5 F#7 Bm9
G C#o D69 --
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">D</span> <span class="o">--</span> <span class="n">Gm7</span> <span class="o">--</span>
<span class="n">D</span> <span class="o">--</span> <span class="n">A7</span> <span class="o">--</span>
<span class="n">D</span> <span class="o">--</span> <span class="n">F</span><span class="c1">#7 Bm</span>
<span class="n">G</span> <span class="n">C</span><span class="c1">#m7b5 F#7 Bm9</span>
<span class="n">G</span> <span class="n">C</span><span class="c1">#o D69 --</span>
</pre></div>
</div>
<p>For more examples, see the <a class="reference external" href="https://jonathangjertsen.github.io/jchord/#examples">documentation</a>.</p>
Expand Down

0 comments on commit afffce0

Please sign in to comment.