Prepare the package for release

Author: 0x2b3bfa0

.github/workflows/release.yml

@@ -3,6 +3,7 @@ name: release
 on:
   release:
     types: [created]
+  workflow_dispatch:
 
 jobs:
   build:
@@ -20,7 +21,6 @@ jobs:
         poetry install
     - name: Run
       run: |
-        poetry build
-        poetry publish
+        poetry publish --build -u __token__ -p "${PYPI_TOKEN}"
       env:
-        POETRY_PYPI_TOKEN_PYPI: ${{env.PYPI_TOKEN}}
+        PYPI_TOKEN: ${{secrets.PYPI_TOKEN}}

README.md

@@ -10,6 +10,9 @@
     <a href="https://github.com/0x2b3bfa0/python-blobopera/actions">
         <img alt="lint" src="https://github.com/0x2b3bfa0/python-blobopera/workflows/coverage/badge.svg?branch=main">
     </a>
+    <a href="https://pypi.org/project/blobopera">
+        <img alt="package" src="https://badge.fury.io/py/blobopera.svg">
+    </a>
     <a href="https://www.gnu.org/licenses/gpl-3.0">
         <img alt="license" src="https://img.shields.io/badge/license-GPL3-blue.svg">
     </a>
@@ -42,39 +45,54 @@ real lyrics, loosely inspired by [OverlappingElvis/blob-opera-midi][2].
    to [MusicXML][4]. You can download MusicXML files from MuseScore
    by using [this tool][8].
 
-2. Install the requirements (using [poetry][11]):
+2. Install the tool:
    ```bash
-   poetry install
+   pip install blobopera
    ```
 
 3. Convert the score file:
    ```bash
-   poetry run blobopera recording import input.musicxml output.binary
+   blobopera recording import input.musicxml output.binary
    ```
+   _[(Take a look at the command-line options)][23]_
 
 4. Upload the recording:
    ```bash
-   poetry run blobopera recording upload output.binary
+   blobopera recording upload output.binary
    ```
 
 5. Visit the generated link with your browser.
 
-## Known issues
-
-* Pronunciation is far from perfect and consonants may be too faint
-  to articulate the supporting note; feel free to add more
-  language-phoneme maps.
+## Roadmap
 
-* Timing can go completely off if the source score has metronome marks on it
-  because they are being interpreted only for the first of the four parts.
-  Please delete all the tempo marks on the score and use the `--tempo` option
-  within the `recording create` subcommand in order to modify the global tempo:
-  0.5 will slow down the entire recording to half the original speed.
+* [X] Publish the package.
+* [ ] Add language-specific phoneme translators.
+* [ ] Improve the phoneme relocation logic.
+* [ ] Write granular unit tests.
+* [ ] Extend the documentation.
 
 ## Contributing
 
-Contributions are welcome! Don't forget to run `poetry run poe all` to
-validate your code before starting a pull request.
+1. Clone this repository:
+   ```console
+   $ git clone https://github.com/0x2b3bfa0/python-blobopera
+   $ cd python-blobopera
+   ```
+
+2. Install the dependencies with [poetry][11]:
+   ```console
+   $ poetry install
+   ```
+
+4. Run the command-line tool:
+   ```console
+   $ poetry run blobopera
+   ```
+
+3. Run the module tests:
+   ```console
+   $ poetry run poe all
+   ```
 
 [1]: https://artsandculture.google.com/experiment/blob-opera/AAHWrq360NcGbw
 [2]: https://github.com/OverlappingElvis/blob-opera-midi
@@ -96,3 +114,4 @@ validate your code before starting a pull request.
 [20]: https://g.co/arts/xQGR5aWBwuDeGqTq8
 [21]: http://www.cafe-puccini.dk/Schubert_GdurMesse.aspx
 [22]: https://en.wikipedia.org/wiki/Ave_Maria_(Schubert)
+[23]: ./documentation/command#blobopera-recording-import

blobopera/recording.py

@@ -23,7 +23,6 @@ class TimedPhoneme(proto.Message):
         Not to be mistaken with :py:class:`.libretto.TimedPhoneme`, which
         serves to a completely different purpose and has different fields.
 
-
     Attributes:
         phoneme (Phoneme): The phoneme to utter.
         duration (float): Duration, whose purpose is yet unknown. Empirically,
@@ -197,7 +196,7 @@ def to_note(self) -> music21.note.GeneralNote:
         # Unfortunately, timing information is being stored as IEEE 754
         # binary32 single-precision float, so we need to reconstruct the
         # original fraction to the nearest denominator to approximate its
-        # real musical duration. This is a humongous HACK and yiends wrong
+        # real musical duration. This is a humongous HACK and yields wrong
         # results for durations below the two hundred fifty-sixth note. This
         # duration is small enough to be considered acceptable, but...
         note.offset = Fraction(self.time).limit_denominator(100)
@@ -241,6 +240,7 @@ def from_part(
             language: The absolute start offset of the note, in seconds.
             tempo: The tempo correction factor; 0.5 makes it twice as slow.
             fill: The phoneme to use if none of the notes has lyrics.
+
         Returns:
             An instance of this class containing the basic information required
             to play the given part.

poetry.lock

@@ -1,9 +1,14 @@
 [tool.poetry]
 name = "blobopera"
-version = "0.1.0"
+version = "1.0.0"
 description = "Unofficial toolkit for Google Arts & Culture Blob Opera"
 authors = ["Helio Machado <0x2b3bfa0@googlemail.com>"]
+maintainers = ["Helio Machado <0x2b3bfa0@googlemail.com>"]
 readme = "README.md"
+license = "GPL-3.0-or-later"
+homepage = "https://github.com/0x2b3bfa0/python-blobopera"
+repository = "https://github.com/0x2b3bfa0/python-blobopera"
+documentation = "https://0x2b3bfa0.github.io/python-blobopera"
 
 [tool.poetry.dependencies]
 python = "^3.9"