Version 0.0.5

CITATION.cff

@@ -0,0 +1,19 @@
+cff-version: 1.2.0
+title: textgrid-tools
+abstract: Command-line interface (CLI) to modify TextGrids and their corresponding audio files.
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - email: [email protected]
+    given-names: Stefan
+    family-names: Taubert
+    affiliation: Chemnitz University of Technology
+    orcid: 'https://orcid.org/0000-0002-4932-2874'
+    website: 'https://stefantaubert.com/'
+version: 0.0.5
+date-released: 2022-11-25
+license: MIT
+url: https://github.com/stefantaubert/textgrid-ipa
+doi: 10.5281/zenodo.7362371

README.md

@@ -5,19 +5,26 @@
 [![MIT](https://img.shields.io/github/license/stefantaubert/textgrid-ipa.svg)](https://github.com/stefantaubert/textgrid-ipa/blob/main/LICENSE)
 [![PyPI](https://img.shields.io/pypi/wheel/textgrid-tools.svg)](https://pypi.python.org/pypi/textgrid-tools/#files)
 ![PyPI](https://img.shields.io/pypi/implementation/textgrid-tools.svg)
-[![PyPI](https://img.shields.io/github/commits-since/stefantaubert/textgrid-ipa/latest/main.svg)](https://github.com/stefantaubert/textgrid-ipa/compare/v0.0.4...main)
+[![PyPI](https://img.shields.io/github/commits-since/stefantaubert/textgrid-ipa/latest/main.svg)](https://github.com/stefantaubert/textgrid-ipa/compare/v0.0.5...main)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7362371.svg)](https://doi.org/10.5281/zenodo.7362371)
 
 Command-line interface (CLI) to modify TextGrids and their corresponding audio files.
 
 ## Features
 
 - grids
   - `merge`: merge grids together
-  - `export-vocabulary`: export vocabulary out of multiple grid files
   - `plot-durations`: plot durations
-  - `export-marks`: exports marks of a tier to a file
   - `mark-durations`: mark intervals with specific durations with a text
   - `create-dictionary`: create pronunciation dictionary out of a word and a pronunciation tier
+  - `plot-stats`: plot statistics
+  - `export-vocabulary`: export vocabulary out of multiple grid files
+  - `export-marks`: exports marks of a tier to a file
+  - `export-durations`: exports durations of grids to a file
+  - `export-paths`: exports grid paths to a file
+  - `export-audio-paths`: exports audio paths to a file
+  - `import-paths`: import grids from paths written in a file
+  - `import-audio-paths`: import audio files from paths written in a file
 - grid
   - `create`: convert text files to grid files
   - `sync`: synchronize grid minTime and maxTime according to the corresponding audio file
@@ -38,7 +45,7 @@ Command-line interface (CLI) to modify TextGrids and their corresponding audio f
   - `import`: import content of tier from a txt file
 - intervals
   - `join`: join adjacent intervals
-  - `join-between-pauses`: join intervals between pauses
+  - `join-between-marks`: join intervals between marks
   - `join-by-boundary`: join intervals by boundaries of a tier
   - `join-by-duration`: join intervals by a duration
   - `join-marks`: join intervals containing specific marks
@@ -47,6 +54,8 @@ Command-line interface (CLI) to modify TextGrids and their corresponding audio f
   - `fix-boundaries`: align boundaries of tiers according to a reference tier
   - `remove`: remove intervals
   - `plot-durations`: plot durations
+  - `join-between-pauses`: join intervals between pauses (LEGACY, please use `join-between-marks`)
+  - `replace-text`: replace text using regex pattern
 
 ## Roadmap
 
@@ -86,6 +95,20 @@ sudo apt-get install ffmpeg -y
 ffmpeg -i *.mp3 -acodec pcm_s16le -ar 22050 *.wav
 ```
 
+## Running the tests
+
+```sh
+git clone https://github.com/stefantaubert/textgrid-ipa.git
+cd textgrid-ipa
+pip install .
+pip install tox
+tox
+```
+
+## Contributing
+
+If you notice an error, please don't hesitate to open an issue.
+
 ## License
 
 MIT License
@@ -96,15 +119,4 @@ Funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation)
 
 ## Citation
 
-If you want to cite this repo, you can use this BibTeX-entry:
-
-```bibtex
-@misc{tstgt22,
-  author = {Taubert, Stefan},
-  title = {textgrid-tools},
-  year = {2022},
-  publisher = {GitHub},
-  journal = {GitHub repository},
-  howpublished = {\url{https://github.com/stefantaubert/textgrid-ipa}}
-}
-```
+If you want to cite this repo, you can use this BibTeX-entry generated by GitHub (see *About => Cite this repository*).

pyproject.toml

@@ -1,15 +1,15 @@
 [project]
 name = "textgrid-tools"
-version = "0.0.4"
+version = "0.0.5"
 description = "Command-line interface (CLI) to modify TextGrids and their corresponding audio files."
 readme = "README.md"
 requires-python = ">=3.8"
 license = {text = "MIT"}
 authors = [
-  {name = "Stefan Taubert", email = "[email protected]"}
+  {name = "Stefan Taubert", email = "[email protected]"}
 ]
 maintainers = [
-  {name = "Stefan Taubert", email = "[email protected]"},
+  {name = "Stefan Taubert", email = "[email protected]"},
 ]
 keywords = [
   "Text-to-speech",

src/textgrid_tools_cli/grids/durations_plotting.py

@@ -7,9 +7,9 @@
 
 from textgrid_tools.grids.durations_plotting import plot_grids_interval_durations_diagram
 from textgrid_tools_cli.globals import ExecutionResult
-from textgrid_tools_cli.helper import (ConvertToOrderedSetAction, add_directory_argument,
-                                       add_encoding_argument, add_tiers_argument, get_grid_files,
-                                       parse_non_empty_or_whitespace, parse_path, try_load_grid)
+from textgrid_tools_cli.helper import (add_directory_argument, add_encoding_argument,
+                                       add_tiers_argument, get_grid_files, parse_path,
+                                       try_load_grid)
 from textgrid_tools_cli.logging_configuration import get_file_logger, init_and_get_console_logger
 
 

src/textgrid_tools_cli/intervals/durations_plotting.py

@@ -5,10 +5,9 @@
 
 from textgrid_tools import plot_interval_durations_diagram
 from textgrid_tools_cli.globals import ExecutionResult
-from textgrid_tools_cli.helper import (ConvertToOrderedSetAction, add_directory_argument,
-                                       add_encoding_argument, add_overwrite_argument,
-                                       add_tiers_argument, get_grid_files, get_optional,
-                                       parse_non_empty_or_whitespace, parse_path, try_load_grid)
+from textgrid_tools_cli.helper import (add_directory_argument, add_encoding_argument,
+                                       add_overwrite_argument, add_tiers_argument, get_grid_files,
+                                       get_optional, parse_path, try_load_grid)
 from textgrid_tools_cli.logging_configuration import get_file_logger, init_and_get_console_logger