bump version

Author: stefantaubert

CHANGELOG.md

@@ -7,16 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.0] - 2025-04-16
+
 ### Added
 
 - GUI which is hosted on Hugging Face
 - Tests for `pypinyin`
 - Support for Python 3.13
 - Missing tests to cover 100 % of the code
+- mypy support
+- ruff linting
 
 ### Bugfix
 
-- `ɔ` missed in the phoneme set
+- `ɔ` missed in the phoneme set in readme
+
+### Removed
+
+- Pipfile and Pipfile.lock
 
 ## [0.0.2] - 2024-02-09
 
@@ -30,6 +38,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release
 
-[unreleased]: https://github.com/stefantaubert/pinyin-to-ipa/compare/v0.0.2...HEAD
+[unreleased]: https://github.com/stefantaubert/pinyin-to-ipa/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/stefantaubert/pinyin-to-ipa/compare/v0.0.2...v1.0.0
 [0.0.2]: https://github.com/stefantaubert/pinyin-to-ipa/compare/v0.0.1...v0.0.2
 [0.0.1]: https://github.com/stefantaubert/pinyin-to-ipa/releases/tag/v0.0.1

CITATION.cff

@@ -1,19 +1,18 @@
 cff-version: 1.2.0
 title: pinyin-to-ipa
-abstract: Command-line interface (CLI) and Python library to transcribe pinyin to IPA.
+abstract: A Python library, web application, and command-line tool for transcribing Pinyin to IPA. Tone markers are attached to the vowel of each syllable.
 message: >-
   If you use this software, please cite it using the
   metadata from this file.
 type: software
 authors:
-  - email: github@stefantaubert.com
-    given-names: Stefan
+  - 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.2
-date-released: 2024-02-09
+version: 1.0.0
+date-released: 2025-04-16
 license: MIT
 url: https://github.com/stefantaubert/pinyin-to-ipa
-doi: 10.5281/zenodo.10639971
+doi: 10.5281/zenodo.15229718

README.md

@@ -3,13 +3,14 @@
 [![CI](https://github.com/stefantaubert/pinyin-to-ipa/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/stefantaubert/pinyin-to-ipa/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/github/stefantaubert/pinyin-to-ipa/branch/master/graph/badge.svg?token=DZ8LB2Q5I0)](https://codecov.io/github/stefantaubert/pinyin-to-ipa)
 [![PyPI](https://img.shields.io/pypi/v/pinyin-to-ipa.svg)](https://pypi.python.org/pypi/pinyin-to-ipa)
-[![Python versions](https://img.shields.io/pypi/pyversions/pinyin-to-ipa.svg)](https://pypi.python.org/pypi/pinyin-to-ipa) \
-[![License: MIT](https://img.shields.io/github/license/stefantaubert/pinyin-to-ipa.svg)](https://github.com/stefantaubert/pinyin-to-ipa/blob/master/LICENSE)
+[![Python versions](https://img.shields.io/pypi/pyversions/pinyin-to-ipa.svg)](https://pypi.python.org/pypi/pinyin-to-ipa)
+[![License: MIT](https://img.shields.io/github/license/stefantaubert/pinyin-to-ipa.svg)](https://github.com/stefantaubert/pinyin-to-ipa/blob/master/LICENSE) \
+[![PyPI Downloads](https://img.shields.io/pypi/dm/pinyin-to-ipa.svg?label=PyPI%20downloads)](https://pypi.org/project/pinyin-to-ipa)
 [![Hugging Face 🤗](https://img.shields.io/badge/%20%F0%9F%A4%97_Hugging_Face-pinyin--to--ipa-blue.svg)](https://huggingface.co/spaces/stefantaubert/pinyin-to-ipa)
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10639971.svg)](https://doi.org/10.5281/zenodo.10639971)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15229718.svg)](https://doi.org/10.5281/zenodo.15229718)
 
-Python library, web app, and command-line interface to transcribe pinyin to IPA.
-The tones are attached to the vowel of the syllable.
+A Python library, web application, and command-line tool for transcribing Pinyin to IPA.  
+Tone markers are attached to the vowel of each syllable.
 
 ## Getting started
 
@@ -149,5 +150,5 @@ Vowels and diphthongs contain one of these tones:
 If you want to cite this repo, you can use this BibTeX-entry generated by GitHub (see *About => Cite this repository*).
 
 ```txt
-Taubert, S. (2025). pinyin-to-ipa (Version 0.0.2) [Computer software]. https://doi.org/10.5281/zenodo.10639971
+Taubert, S. (2025). pinyin-to-ipa (Version 1.0.0) [Computer software]. https://doi.org/10.5281/zenodo.15229718
 ```

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "pinyin-to-ipa"
-version = "0.0.2"
-description = "Command-line interface (CLI) and Python library to transcribe pinyin to IPA."
+version = "1.0.0"
+description = "A Python library, web application, and command-line tool for transcribing Pinyin to IPA. Tone markers are attached to the vowel of each syllable."
 readme = "README.md"
 requires-python = ">=3.8, <3.14"
 license = { file = "LICENSE" }
@@ -10,16 +10,28 @@ maintainers = [
   { name = "Stefan Taubert" },
 ]
 keywords = [
-  "Pronunciation",
-  "Dictionary",
   "Chinese",
-  "IPA",
+  "Mandarin",
   "Pinyin",
+  "IPA",
+  "Phonetics",
+  "Phonology",
+  "Tone",
+  "Transcription",
   "Language",
   "Linguistics",
+  "Speech",
+  "Romanization",
+  "Language Learning",
+  "Natural Language Processing",
+  "Grapheme-to-Phoneme"
 ]
 classifiers = [
-  "Development Status :: 4 - Beta",
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Education",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
   "Operating System :: OS Independent",
   "Operating System :: MacOS",
   "Operating System :: POSIX",
@@ -35,11 +47,15 @@ classifiers = [
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
-  "License :: OSI Approved :: MIT License",
   "Topic :: Multimedia :: Sound/Audio",
   "Topic :: Multimedia :: Sound/Audio :: Analysis",
   "Topic :: Multimedia :: Sound/Audio :: Sound Synthesis",
   "Topic :: Multimedia :: Sound/Audio :: Speech",
+  "Topic :: Text Processing :: Linguistic",
+  "Topic :: Scientific/Engineering :: Human Machine Interfaces",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Environment :: Console",
+  "Environment :: Web Environment"
 ]
 dependencies = ["ordered-set>=4.1.0", "pypinyin>=0.54"]
 

src/pinyin_to_ipa/transcription.py

@@ -250,14 +250,14 @@ def apply_tone(
 
 def pinyin_to_ipa(pinyin: str) -> OrderedSet[Tuple[str, ...]]:
   """
-  Convert a Pinyin string into its corresponding
+  Convert a Pinyin syllable into its corresponding
   International Phonetic Alphabet (IPA) transcription.
 
   Parameters
   ----------
   pinyin : str
-      A string representing the Pinyin input to be transcribed into IPA. The input
-      can include tone markers (e.g., "ma1", "zhong4").
+      A syllable representing the Pinyin input to be transcribed into IPA. The input
+      can include tone markers (e.g., "zhong", "zhōng", "zho1ng", "zhong1").
 
   Returns
   -------

src/pinyin_to_ipa_app/app.py

@@ -103,7 +103,7 @@ def build_interface() -> gr.Blocks:
 
         ### Citation
 
-        Taubert, S. (2024). pinyin-to-ipa (Version 0.0.2) [Computer software]. https://doi.org/10.5281/zenodo.10639971
+        Taubert, S. (2024). pinyin-to-ipa (Version 1.0.0) [Computer software]. https://doi.org/10.5281/zenodo.15229718
 
         ### References
 
@@ -124,7 +124,7 @@ def build_interface() -> gr.Blocks:
 
         ### App information
 
-        - Version: 0.0.2
+        - Version: 1.0.0
         - License: [MIT](https://github.com/stefantaubert/pinyin-to-ipa?tab=MIT-1-ov-file#readme)
         - GitHub: [stefantaubert/pinyin-to-ipa](https://github.com/stefantaubert/pinyin-to-ipa)
         """