kernpy 1.0.0__tar.gz → 1.0.2__tar.gz

{kernpy-1.0.0 → kernpy-1.0.2}/CONTRIBUTING.md

@@ -1,9 +1,13 @@
 # Contributing to kernpy
 
+>
+> Go to [Developer Notes](#developer-notes) for specific guidelines for developers.
+> 
+
 We welcome your contributions to `kernpy`‼️  
 Our goal is to make contributing as easy and transparent as possible. Whether you're fixing bugs, improving documentation, or adding new features, or creating new tests, thank you for helping improve `kernpy`!
 
-## How to Contribute
+<br>
 
 ## Step-by-Step Guide 📖
 1. Fork the Repository
@@ -44,4 +48,54 @@ Testing: Every change must pass the build tests. Run tests locally using the pro
 
 By contributing to `kernpy`, you agree that your contributions will be licensed under the terms specified in the LICENSE file at the root of this project.
 
-Happy coding and thank you for contributing! 🚀
+Happy coding and thank you for contributing! 🚀
+
+
+# Developer notes
+
+> [!IMPORTANT]
+> - Add the development dependencies to the `requirements.txt` file.
+> - Add the production dependencies to the `pyproject.toml` file.
+> - After every change in the grammar, the next steps are mandatory:
+> - - Run the `antlr4.sh` script (JAVA required).
+> - - Commit & push the changes to the repository.
+
+
+- Generate antrl4 grammar:
+- For generating the Python code required for parsing the **kern files, the shell script `antlr4.sh` inside the `kernpy` package must be run.
+
+```shell
+./antlr4.sh
+```
+
+Install all the dependencies using the `requirements.txt` file:
+```shell
+pip install -r requirements.txt
+```
+
+Otherwise, install the required packages manually:
+
+
+- It requires the `antlr4` package to be installed using:
+```shell
+pip install antlr4-python3-runtime
+```
+
+
+- For visualizing the bounding boxes, the library, the `Pillow` library is required:
+```shell
+pip install Pillow
+```
+
+- To parse a IIIF (International Image Interoperability Framework) manifest in Python, we use the `requests` library to fetch the manifest file:
+```shell
+pip install requests
+```
+
+- If fetching data from `https` fails, install the following version of `urllib`:
+```shell
+pip install urllib3==1.26.6
+```
+
+It has been tested with version 4.13.1 of the package.
+

{kernpy-1.0.0 → kernpy-1.0.2}/License

@@ -629,13 +629,12 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Python package that provides comprehensive tools for working with symbolic modern and mensural notations in Humdrum format. kernpy is a fully open-source project open to contributions.
+    Copyright (C) 2025  [Joan Cerveto-Serrano, David Rizo, Jorge Calvo-Zaragoza]
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU Affero General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
+    the Free Software Foundation, either version 3 of the License any later version.
 
     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of

{kernpy-1.0.0 → kernpy-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kernpy
-Version: 1.0.0
+Version: 1.0.2
 Summary: Python Humdrum **kern and **mens utilities
 Project-URL: Homepage, https://github.com/OMR-PRAIG-UA-ES/kernpy
 Project-URL: Documentation, https://github.com/OMR-PRAIG-UA-ES/kernpy#readme
@@ -19,9 +19,18 @@ Description-Content-Type: text/markdown
 
 # Python Humdrum **kern and **mens utilities
 
-## Documentation: <a target="_blank" href="https://kernpy.pages.dev/">https://kernpy.pages.dev/</a>
+[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg?style=for-the-badge)](https://www.gnu.org/licenses/agpl-3.0)
+![Python Version](https://img.shields.io/badge/Python-3.9+-3776AB?logo=python&logoColor=white&style=for-the-badge)
+[![PyPI](https://img.shields.io/pypi/v/kernpy?color=brightgreen&label=PyPI&style=for-the-badge&logo=pypi)](https://pypi.org/project/kernpy/)
+[![Docs](https://img.shields.io/badge/docs-available-blue?style=for-the-badge&logo=readthedocs)](https://kernpy.pages.dev)
+[![Tests](https://img.shields.io/badge/tests-passing-brightgreen?style=for-the-badge&logo=pytest)](https://github.com/kernpy/kernpy/actions)
+[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-orange?style=for-the-badge&logo=github)](CONTRIBUTING.md)
 
-![kernpy logo](https://static.wixstatic.com/media/7a8a67_90be144dbf384480908c3327b93ba97a~mv2.jpg/v1/fill/w_461,h_354,fp_0.46_0.20,q_80,usm_0.66_1.00_0.01,enc_avif,quality_auto/mending-the-sail-1896_jpg!Large.jpg)
+
+Python package that provides comprehensive tools for working with symbolic modern and mensural notations in Humdrum format. kernpy is a fully open-source project open to contributions.
+
+## Documentation 
+Visit the online website: <a target="_blank" href="https://kernpy.pages.dev/">https://kernpy.pages.dev/</a>
 
 ## Index:
 - [Code examples](#code-examples)
@@ -71,18 +80,74 @@ Only use the specified spines in `spine_types`.
 ```python
 import kernpy as kp
 
+# only export the **kern spines
 kp.dump(document, "newfile_core.krn",
         spine_types=['**kern'])
+
+# only export the **text spines
 kp.dump(document, "newfile_lyrics.krn",
         spine_types=['**text])
+                     
+# only export **kern and **text spines     
 kp.dump(document, "newfile_core_and_lyrics.krn",
         spine_types=['*+text'])
 ```
 
+- The categories are hierarchically defined in the `TokenCategory` class.
+See the hierarchy as a tree
+```python
+import kernpy as kp
+
+
+print(kp.TokenCategory.tree())
+```
+Tree:
+```txt
+.
+├── STRUCTURAL
+│   ├── HEADER
+│   └── SPINE_OPERATION
+├── CORE
+│   ├── NOTE_REST
+│   │   ├── DURATION
+│   │   ├── NOTE
+│   │   │   ├── PITCH
+│   │   │   ├── DECORATION
+│   │   │   └── ALTERATION
+│   │   └── REST
+│   ├── CHORD
+│   ├── EMPTY
+│   └── ERROR
+├── SIGNATURES
+│   ├── CLEF
+│   ├── TIME_SIGNATURE
+│   ├── METER_SYMBOL
+│   ├── KEY_SIGNATURE
+│   └── KEY_TOKEN
+├── ENGRAVED_SYMBOLS
+├── OTHER_CONTEXTUAL
+├── BARLINES
+├── COMMENTS
+│   ├── FIELD_COMMENTS
+│   └── LINE_COMMENTS
+├── DYNAMICS
+├── HARMONY
+├── FINGERING
+├── LYRICS
+├── INSTRUMENTS
+├── IMAGE_ANNOTATIONS
+│   ├── BOUNDING_BOXES
+│   └── LINE_BREAK
+├── OTHER
+├── MHXM
+└── ROOT
+```
+
 - Use `include` for selecting the **kern semantic categories **to use**. The output only contains what is passed. By default, all the categories are included.
 ```python
 import kernpy as kp
 
+
 kp.dump(document, "newfile_only_clefs.krn",
         include={kp.TokenCategory.CLEF})
 kp.dump(document, "newfile_only_durations_and_bounding_boxes.krn",
@@ -104,34 +169,37 @@ import kernpy as kp
 kp.dump(document, "newfile_custom.krn",
         include=kp.BEKERN_CATEGORIES,  # Preloaded set of simple categories
         exclude={kp.TokenCategory.PITCH})
+
+# Inspect the BEKERN preloaded categories
+print(kp.BEKERN_CATEGORIES)
 ```
 
-- Use `tokenizer` to select how the categories are split. By default, the `normalizedKern` tokenizer is used.
+- Use `encoding` to select how the categories are split. By default, the `normalizedKern` encoding is used.
 
 ```python
 import kernpy as kp
 
 kp.dump(document, "newfile_normalized.krn",
-        tokenizer=kp.Encoding.normalizedKern)  # Default tokenizer
+        encoding=kp.Encoding.normalizedKern)  # Default encoding
 ```
-Select the proper Humdrum **kern tokenizer:
+Select the proper Humdrum **kern encoding:
 
-`kernpy` provides different tokenizers to export the content each symbol in different formats.
+`kernpy` provides different encodings to export the content each symbol in different formats.
 
-| Encoding | Tokenized    | Description                            |
+| Encoding | Output       | Description                            |
 |----------|--------------|----------------------------------------|
 | kern     | 2.bb-_L      | Traditional Humdrum **kern encoding    |
 | ekern    | 2@.@bb@-·_·L | Extended Humdrum **kern encoding       |
 
-Use the `Encoding` enum class to select the tokenizer:
+Use the `Encoding` enum class to select the encoding:
 
 ```python
 import kernpy as kp
 
 doc, _ = kp.load('resource_dir/legacy/chor048.krn')
 
-kern_content = kp.dumps(doc, tokenizer=kp.Encoding.normalizedKern)
-ekern_content = kp.dumps(doc, tokenizer=kp.Encoding.eKern)
+kern_content = kp.dumps(doc, encoding=kp.Encoding.normalizedKern)
+ekern_content = kp.dumps(doc, encoding=kp.Encoding.eKern)
 ```
 
 - Use `from_measure` and `to_measure` to select the measures to export. By default, all the measures are exported.
@@ -168,7 +236,7 @@ kp.dump(document, "newfile.krn",
         spine_types=['**kern'],  # Export only the **kern spines
         include=kp.BEKERN_CATEGORIES,  # Token categories to include
         exclude={kp.TokenCategory.PITCH},  # Token categories to exclude
-        tokenizer=kp.Encoding.eKern,  # Kern encoding
+        encoding=kp.Encoding.eKern,  # Kern encoding
         from_measure=1,  # First from measure 1
         to_measure=10,  # Last measure exported
         spine_ids=[0, 1],  # Export only the first and the second spine
@@ -271,7 +339,7 @@ for page_label, bounding_box_measure in doc.page_bounding_boxes.items():
    kp.dump(doc, f"foo_{page_label}.ekrn",
            spine_types=['**kern'],
            token_categories=kp.BEKERN_CATEGORIES,
-           tokenizer=kp.Encoding.eKern,
+           encoding=kp.Encoding.eKern,
            from_measure=bounding_box_measure.from_measure,
            to_measure=bounding_box_measure.to_measure - 1  # TODO: Check bounds            
            )
@@ -382,8 +450,10 @@ kp.graph(document, '/tmp/graph.dot')
 ### Production version:
 Just install the last version of **kernpy** using pip:
 ```shell
-pip3 uninstall kernpy     # Uninstall the previous version before installing the new one
-pip3 install git+https://github.com/OMR-PRAIG-UA-ES/kernpy.git
+pip3 install kernpy
+
+# ensure you have the latest version
+pip3 install kernpy --upgrade 
 ```
 
 > [!NOTE]
@@ -391,55 +461,6 @@ pip3 install git+https://github.com/OMR-PRAIG-UA-ES/kernpy.git
 
 <hr>
 
-### Development version:
-
-> [!IMPORTANT]  
-> - Add the development dependencies to the `requirements.txt` file.
-> - Add the production dependencies to the `pyproject.toml` file.
-> - After every change in the grammar, the next steps are mandatory:
-> - - Run the `antlr4.sh` script (JAVA required).
-> - - Commit & push the changes to the repository.
-
-
-- Generate antrl4 grammar:
-- For generating the Python code required for parsing the **kern files, the shell script `antlr4.sh` inside the `kernpy` package must be run.
-
-```shell
-./antlr4.sh
-```
-
-Install all the dependencies using the `requirements.txt` file:
-```shell
-pip install -r requirements.txt
-```
-
-Otherwise, install the required packages manually:
-
-
-- It requires the `antlr4` package to be installed using:
-```shell
-pip install antlr4-python3-runtime
-```
-
-
-- For visualizing the bounding boxes, the library, the `Pillow` library is required:
-```shell
-pip install Pillow
-```
-
-- To parse a IIIF (International Image Interoperability Framework) manifest in Python, we use the `requests` library to fetch the manifest file:
-```shell
-pip install requests
-```
-
-- If fetching data from `https` fails, install the following version of `urllib`:
-```shell
-pip install urllib3==1.26.6
-```
-
-It has been tested with version 4.13.1 of the package.
-
-
 ## Documentation
 Documentation available at [https://kernpy.pages.dev/](https://kernpy.pages.dev/)
 
@@ -461,32 +482,7 @@ cd tests && python -m pytest
 
 We welcome contributions from the community! If you'd like to contribute to the project, please follow these steps:
 
-1. Fork the Repository from GitHub.
-2. Clone your own fork repository.
-   ```bash
-   git clone ...
-   cd ...
-   ```
-3. Create a Branch:
-4. Create a new branch for your feature or bug fix:
-   ```bash
-   git checkout -b feature/your-feature-name
-    ```
-5. Commit Your Changes:
-Commit your changes with a descriptive message:
-    ```bash
-    git commit -m "feat: add your feature or fix"
-     ```
-
-6. Push to Your Branch:
-Push your changes to your forked repository:
-    ```bash
-    git push origin feature/your-feature-name
-     ```
-
-7. Create a Pull Request:
-Open a pull request to the main repository, describing your changes.
-
+Go to the file [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to contribute.
 
 ## Citation:
 ```bibtex

{kernpy-1.0.0 → kernpy-1.0.2}/README.md

@@ -1,8 +1,17 @@
 # Python Humdrum **kern and **mens utilities
 
-## Documentation: <a target="_blank" href="https://kernpy.pages.dev/">https://kernpy.pages.dev/</a>
+[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg?style=for-the-badge)](https://www.gnu.org/licenses/agpl-3.0)
+![Python Version](https://img.shields.io/badge/Python-3.9+-3776AB?logo=python&logoColor=white&style=for-the-badge)
+[![PyPI](https://img.shields.io/pypi/v/kernpy?color=brightgreen&label=PyPI&style=for-the-badge&logo=pypi)](https://pypi.org/project/kernpy/)
+[![Docs](https://img.shields.io/badge/docs-available-blue?style=for-the-badge&logo=readthedocs)](https://kernpy.pages.dev)
+[![Tests](https://img.shields.io/badge/tests-passing-brightgreen?style=for-the-badge&logo=pytest)](https://github.com/kernpy/kernpy/actions)
+[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-orange?style=for-the-badge&logo=github)](CONTRIBUTING.md)
 
-![kernpy logo](https://static.wixstatic.com/media/7a8a67_90be144dbf384480908c3327b93ba97a~mv2.jpg/v1/fill/w_461,h_354,fp_0.46_0.20,q_80,usm_0.66_1.00_0.01,enc_avif,quality_auto/mending-the-sail-1896_jpg!Large.jpg)
+
+Python package that provides comprehensive tools for working with symbolic modern and mensural notations in Humdrum format. kernpy is a fully open-source project open to contributions.
+
+## Documentation 
+Visit the online website: <a target="_blank" href="https://kernpy.pages.dev/">https://kernpy.pages.dev/</a>
 
 ## Index:
 - [Code examples](#code-examples)
@@ -52,18 +61,74 @@ Only use the specified spines in `spine_types`.
 ```python
 import kernpy as kp
 
+# only export the **kern spines
 kp.dump(document, "newfile_core.krn",
         spine_types=['**kern'])
+
+# only export the **text spines
 kp.dump(document, "newfile_lyrics.krn",
         spine_types=['**text])
+                     
+# only export **kern and **text spines     
 kp.dump(document, "newfile_core_and_lyrics.krn",
         spine_types=['*+text'])
 ```
 
+- The categories are hierarchically defined in the `TokenCategory` class.
+See the hierarchy as a tree
+```python
+import kernpy as kp
+
+
+print(kp.TokenCategory.tree())
+```
+Tree:
+```txt
+.
+├── STRUCTURAL
+│   ├── HEADER
+│   └── SPINE_OPERATION
+├── CORE
+│   ├── NOTE_REST
+│   │   ├── DURATION
+│   │   ├── NOTE
+│   │   │   ├── PITCH
+│   │   │   ├── DECORATION
+│   │   │   └── ALTERATION
+│   │   └── REST
+│   ├── CHORD
+│   ├── EMPTY
+│   └── ERROR
+├── SIGNATURES
+│   ├── CLEF
+│   ├── TIME_SIGNATURE
+│   ├── METER_SYMBOL
+│   ├── KEY_SIGNATURE
+│   └── KEY_TOKEN
+├── ENGRAVED_SYMBOLS
+├── OTHER_CONTEXTUAL
+├── BARLINES
+├── COMMENTS
+│   ├── FIELD_COMMENTS
+│   └── LINE_COMMENTS
+├── DYNAMICS
+├── HARMONY
+├── FINGERING
+├── LYRICS
+├── INSTRUMENTS
+├── IMAGE_ANNOTATIONS
+│   ├── BOUNDING_BOXES
+│   └── LINE_BREAK
+├── OTHER
+├── MHXM
+└── ROOT
+```
+
 - Use `include` for selecting the **kern semantic categories **to use**. The output only contains what is passed. By default, all the categories are included.
 ```python
 import kernpy as kp
 
+
 kp.dump(document, "newfile_only_clefs.krn",
         include={kp.TokenCategory.CLEF})
 kp.dump(document, "newfile_only_durations_and_bounding_boxes.krn",
@@ -85,34 +150,37 @@ import kernpy as kp
 kp.dump(document, "newfile_custom.krn",
         include=kp.BEKERN_CATEGORIES,  # Preloaded set of simple categories
         exclude={kp.TokenCategory.PITCH})
+
+# Inspect the BEKERN preloaded categories
+print(kp.BEKERN_CATEGORIES)
 ```
 
-- Use `tokenizer` to select how the categories are split. By default, the `normalizedKern` tokenizer is used.
+- Use `encoding` to select how the categories are split. By default, the `normalizedKern` encoding is used.
 
 ```python
 import kernpy as kp
 
 kp.dump(document, "newfile_normalized.krn",
-        tokenizer=kp.Encoding.normalizedKern)  # Default tokenizer
+        encoding=kp.Encoding.normalizedKern)  # Default encoding
 ```
-Select the proper Humdrum **kern tokenizer:
+Select the proper Humdrum **kern encoding:
 
-`kernpy` provides different tokenizers to export the content each symbol in different formats.
+`kernpy` provides different encodings to export the content each symbol in different formats.
 
-| Encoding | Tokenized    | Description                            |
+| Encoding | Output       | Description                            |
 |----------|--------------|----------------------------------------|
 | kern     | 2.bb-_L      | Traditional Humdrum **kern encoding    |
 | ekern    | 2@.@bb@-·_·L | Extended Humdrum **kern encoding       |
 
-Use the `Encoding` enum class to select the tokenizer:
+Use the `Encoding` enum class to select the encoding:
 
 ```python
 import kernpy as kp
 
 doc, _ = kp.load('resource_dir/legacy/chor048.krn')
 
-kern_content = kp.dumps(doc, tokenizer=kp.Encoding.normalizedKern)
-ekern_content = kp.dumps(doc, tokenizer=kp.Encoding.eKern)
+kern_content = kp.dumps(doc, encoding=kp.Encoding.normalizedKern)
+ekern_content = kp.dumps(doc, encoding=kp.Encoding.eKern)
 ```
 
 - Use `from_measure` and `to_measure` to select the measures to export. By default, all the measures are exported.
@@ -149,7 +217,7 @@ kp.dump(document, "newfile.krn",
         spine_types=['**kern'],  # Export only the **kern spines
         include=kp.BEKERN_CATEGORIES,  # Token categories to include
         exclude={kp.TokenCategory.PITCH},  # Token categories to exclude
-        tokenizer=kp.Encoding.eKern,  # Kern encoding
+        encoding=kp.Encoding.eKern,  # Kern encoding
         from_measure=1,  # First from measure 1
         to_measure=10,  # Last measure exported
         spine_ids=[0, 1],  # Export only the first and the second spine
@@ -252,7 +320,7 @@ for page_label, bounding_box_measure in doc.page_bounding_boxes.items():
    kp.dump(doc, f"foo_{page_label}.ekrn",
            spine_types=['**kern'],
            token_categories=kp.BEKERN_CATEGORIES,
-           tokenizer=kp.Encoding.eKern,
+           encoding=kp.Encoding.eKern,
            from_measure=bounding_box_measure.from_measure,
            to_measure=bounding_box_measure.to_measure - 1  # TODO: Check bounds            
            )
@@ -363,8 +431,10 @@ kp.graph(document, '/tmp/graph.dot')
 ### Production version:
 Just install the last version of **kernpy** using pip:
 ```shell
-pip3 uninstall kernpy     # Uninstall the previous version before installing the new one
-pip3 install git+https://github.com/OMR-PRAIG-UA-ES/kernpy.git
+pip3 install kernpy
+
+# ensure you have the latest version
+pip3 install kernpy --upgrade 
 ```
 
 > [!NOTE]
@@ -372,55 +442,6 @@ pip3 install git+https://github.com/OMR-PRAIG-UA-ES/kernpy.git
 
 <hr>
 
-### Development version:
-
-> [!IMPORTANT]  
-> - Add the development dependencies to the `requirements.txt` file.
-> - Add the production dependencies to the `pyproject.toml` file.
-> - After every change in the grammar, the next steps are mandatory:
-> - - Run the `antlr4.sh` script (JAVA required).
-> - - Commit & push the changes to the repository.
-
-
-- Generate antrl4 grammar:
-- For generating the Python code required for parsing the **kern files, the shell script `antlr4.sh` inside the `kernpy` package must be run.
-
-```shell
-./antlr4.sh
-```
-
-Install all the dependencies using the `requirements.txt` file:
-```shell
-pip install -r requirements.txt
-```
-
-Otherwise, install the required packages manually:
-
-
-- It requires the `antlr4` package to be installed using:
-```shell
-pip install antlr4-python3-runtime
-```
-
-
-- For visualizing the bounding boxes, the library, the `Pillow` library is required:
-```shell
-pip install Pillow
-```
-
-- To parse a IIIF (International Image Interoperability Framework) manifest in Python, we use the `requests` library to fetch the manifest file:
-```shell
-pip install requests
-```
-
-- If fetching data from `https` fails, install the following version of `urllib`:
-```shell
-pip install urllib3==1.26.6
-```
-
-It has been tested with version 4.13.1 of the package.
-
-
 ## Documentation
 Documentation available at [https://kernpy.pages.dev/](https://kernpy.pages.dev/)
 
@@ -442,32 +463,7 @@ cd tests && python -m pytest
 
 We welcome contributions from the community! If you'd like to contribute to the project, please follow these steps:
 
-1. Fork the Repository from GitHub.
-2. Clone your own fork repository.
-   ```bash
-   git clone ...
-   cd ...
-   ```
-3. Create a Branch:
-4. Create a new branch for your feature or bug fix:
-   ```bash
-   git checkout -b feature/your-feature-name
-    ```
-5. Commit Your Changes:
-Commit your changes with a descriptive message:
-    ```bash
-    git commit -m "feat: add your feature or fix"
-     ```
-
-6. Push to Your Branch:
-Push your changes to your forked repository:
-    ```bash
-    git push origin feature/your-feature-name
-     ```
-
-7. Create a Pull Request:
-Open a pull request to the main repository, describing your changes.
-
+Go to the file [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to contribute.
 
 ## Citation:
 ```bibtex

{kernpy-1.0.0 → kernpy-1.0.2}/docs/get-started/tutorial.md

@@ -117,15 +117,15 @@ kp.dump(document, "newfile_custom.krn",
         exclude={kp.TokenCategory.PITCH})
 ```
 
-- Use `tokenizer` to select how the categories are split. By default, the `normalizedKern` tokenizer is used.
+- Use `encoding` to select how the categories are split. By default, the `normalizedKern` encoding is used.
 
 ```python
 import kernpy as kp
 
 kp.dump(document, "newfile_normalized.krn",
-        tokenizer=kp.Encoding.normalizedKern)  # Default tokenizer
+        encoding=kp.Encoding.normalizedKern)  # Default encoding
 ```
-Select the proper Humdrum **kern tokenizer:
+Select the proper Humdrum **kern encoding:
 
 `kernpy` provides different tokenizers to export the content each symbol in different formats.
 
@@ -134,15 +134,15 @@ Select the proper Humdrum **kern tokenizer:
 | kern     | 2.bb-_L      | Traditional Humdrum **kern encoding    |
 | ekern    | 2@.@bb@-·_·L | Extended Humdrum **kern encoding       |
 
-Use the `Encoding` enum class to select the tokenizer:
+Use the `Encoding` enum class to select the encoding:
 
 ```python
 import kernpy as kp
 
 doc, _ = kp.load('resource_dir/legacy/chor048.krn')
 
-kern_content = kp.dumps(doc, tokenizer=kp.Encoding.normalizedKern)
-ekern_content = kp.dumps(doc, tokenizer=kp.Encoding.eKern)
+kern_content = kp.dumps(doc, encoding=kp.Encoding.normalizedKern)
+ekern_content = kp.dumps(doc, encoding=kp.Encoding.eKern)
 ```
 
 - Use `from_measure` and `to_measure` to select the measures to export. By default, all the measures are exported.
@@ -179,7 +179,7 @@ kp.dump(document, "newfile.krn",
         spine_types=['**kern'],  # Export only the **kern spines
         include=kp.BEKERN_CATEGORIES,  # Token categories to include
         exclude={kp.TokenCategory.PITCH},  # Token categories to exclude
-        tokenizer=kp.Encoding.eKern,  # Kern encoding
+        encoding=kp.Encoding.eKern,  # Kern encoding
         from_measure=1,  # First from measure 1
         to_measure=10,  # Last measure exported
         spine_ids=[0, 1],  # Export only the first and the second spine
@@ -282,7 +282,7 @@ for page_label, bounding_box_measure in doc.page_bounding_boxes.items():
     kp.dump(doc, f"foo_{page_label}.ekrn",
             spine_types=['**kern'],
             token_categories=kp.BEKERN_CATEGORIES,
-            tokenizer=kp.Encoding.eKern,
+            encoding=kp.Encoding.eKern,
             from_measure=bounding_box_measure.from_measure,
             to_measure=bounding_box_measure.to_measure - 1  # TODO: Check bounds            
             )

{kernpy-1.0.0 → kernpy-1.0.2}/docs/get-started.md

@@ -4,10 +4,10 @@
 
 Instructions for installing `kernpy` are provided below.
 
-### Install `kernpy` using `pip`
+### Install the last version of `kernpy` using `pip`
 
 ```bash
-pip install kernpy
+pip3 install kernpy --upgrade
 ```