a2pcej


Namea2pcej JSON
Version 0.2.4 PyPI version JSON
download
home_pageNone
Summarya2pcej, convert Alphabet to Phonetic Code in English and Japanese.
upload_time2025-08-20 06:22:22
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords alphabet katakana phonetic code
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            a2pcej
======
[![Code Climate](https://codeclimate.com/github/kacchan822/a2pcej/badges/gpa.svg)](https://codeclimate.com/github/kacchan822/a2pcej)
[![Issue Count](https://codeclimate.com/github/kacchan822/a2pcej/badges/issue_count.svg)](https://codeclimate.com/github/kacchan822/a2pcej)
[![Coverage Status](https://coveralls.io/repos/github/kacchan822/a2pcej/badge.svg?branch=master)](https://coveralls.io/github/kacchan822/a2pcej?branch=master)
[![Latest Version](https://img.shields.io/pypi/v/a2pcej.svg)](https://pypi.python.org/pypi/a2pcej)


__a2pcej__, convert Alphabet to Phonetic Code in English and Japanese.

This module convert each alphabet letters to phonetic code,
and also convert each alphabet letters to katakana.


### Functions
#### conv_al(letters, delimiter='-', upper_sign='(CAPS)', num=False)
letters is string.

```python
def conv_al(letters, delimiter='-', sign='(CAPS)', num=False):
    return str
```
#### conv_ak(letters, delimiter='・', upper_sign='(大文字)', num=False)
letters is string.
```python
def conv_ak(letters, delimiter='・', sign='(大文字)', num=False):
    return str
```

### Simple example of usage

First of all, import module.
```python
>>> from a2pcej import *
```
Convert 'examples' to Phonetic code in English.
```python
>>> conv_al('examples')
'Echo-Xray-Alfa-Mike-Papa-Lima-Echo-Sierra'
```

Convert 'examples' to Phonetic code in Japanese Katakana.
```python
>>> conv_ak('examples')
'イー・エクス・エイ・エム・ピー・エル・イー・エス'
```

Non alphabet letters are not convert (default).  
Upper case letters has (CAPS) or (大文字) sign (default).
```python
>>> conv_al('Examples002')
'Echo(CAPS)-Xray-Alfa-Mike-Papa-Lima-Echo-Sierra-0-0-2'
>>> conv_ak('Examples002')
'イー(大文字)・エクス・エイ・エム・ピー・エル・イー・エス・0・0・2'
```

You can change delimiter and Upper case letters sign.
```python
>>> conv_al('Examples003', delimiter=', ', sign='(CAPITAL)')
'Echo(CAPITAL), Xray, Alfa, Mike, Papa, Lima, Echo, Sierra, 0, 0, 3'
>>> conv_ak('Examples003', delimiter='/', sign='(大)')
'イー(大)/エクス/エイ/エム/ピー/エル/イー/エス/0/0/3'
```

If you would like to convert numbers to phonetic code, set `num=True`.
```python
>>> conv_al('Examples004', num=True)
'Echo(CAPS)-Xray-Alfa-Mike-Papa-Lima-Echo-Sierra-zero-zero-four'
>>> conv_ak('Examples004', num=True)
'イー(大文字)・エクス・エイ・エム・ピー・エル・イー・エス・ゼロ・ゼロ・ヨン'
```

## Development and Release

### Setting up for development

```bash
# Clone the repository
git clone https://github.com/kacchan822/a2pcej.git
cd a2pcej

# Install in development mode
pip install -e .[dev]

# Run tests
pytest tests/ -v

# Format code
black .
isort .

# Lint code
flake8 .
```

### Release Process

This project uses automated releases via GitHub Actions. To create a new release:

1. Update the version information and commit your changes
2. Create and push a tag:
   ```bash
   git tag v1.0.0  # Replace with your version
   git push origin v1.0.0
   ```
3. GitHub Actions will automatically:
   - Run tests across multiple Python versions
   - Build the package
   - Publish to PyPI

### GitHub Actions Setup

To enable automatic PyPI publishing, you need to set up authentication:

#### Option 1: PyPI API Token (Traditional)
1. Create an API token on PyPI
2. Add it as `PYPI_API_TOKEN` in GitHub repository secrets

#### Option 2: Trusted Publishing (Recommended)
1. Configure Trusted Publishing on PyPI for this repository
2. No secrets needed - uses OpenID Connect (OIDC)

For more details, see the [PyPI documentation on Trusted Publishing](https://docs.pypi.org/trusted-publishers/).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "a2pcej",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "alphabet, katakana, phonetic code",
    "author": null,
    "author_email": "Katsuya SAITO <hello@skatsuya.com>",
    "download_url": "https://files.pythonhosted.org/packages/17/51/464613eb079211e9b0265b1d37ea7b0fd6274a47b8cd9bdea6c2f6f16ed9/a2pcej-0.2.4.tar.gz",
    "platform": null,
    "description": "a2pcej\n======\n[![Code Climate](https://codeclimate.com/github/kacchan822/a2pcej/badges/gpa.svg)](https://codeclimate.com/github/kacchan822/a2pcej)\n[![Issue Count](https://codeclimate.com/github/kacchan822/a2pcej/badges/issue_count.svg)](https://codeclimate.com/github/kacchan822/a2pcej)\n[![Coverage Status](https://coveralls.io/repos/github/kacchan822/a2pcej/badge.svg?branch=master)](https://coveralls.io/github/kacchan822/a2pcej?branch=master)\n[![Latest Version](https://img.shields.io/pypi/v/a2pcej.svg)](https://pypi.python.org/pypi/a2pcej)\n\n\n__a2pcej__, convert Alphabet to Phonetic Code in English and Japanese.\n\nThis module convert each alphabet letters to phonetic code,\nand also convert each alphabet letters to katakana.\n\n\n### Functions\n#### conv_al(letters, delimiter='-', upper_sign='(CAPS)', num=False)\nletters is string.\n\n```python\ndef conv_al(letters, delimiter='-', sign='(CAPS)', num=False):\n    return str\n```\n#### conv_ak(letters, delimiter='\u30fb', upper_sign='\uff08\u5927\u6587\u5b57\uff09', num=False)\nletters is string.\n```python\ndef conv_ak(letters, delimiter='\u30fb', sign='\uff08\u5927\u6587\u5b57\uff09', num=False):\n    return str\n```\n\n### Simple example of usage\n\nFirst of all, import module.\n```python\n>>> from a2pcej import *\n```\nConvert 'examples' to Phonetic code in English.\n```python\n>>> conv_al('examples')\n'Echo-Xray-Alfa-Mike-Papa-Lima-Echo-Sierra'\n```\n\nConvert 'examples' to Phonetic code in Japanese Katakana.\n```python\n>>> conv_ak('examples')\n'\u30a4\u30fc\u30fb\u30a8\u30af\u30b9\u30fb\u30a8\u30a4\u30fb\u30a8\u30e0\u30fb\u30d4\u30fc\u30fb\u30a8\u30eb\u30fb\u30a4\u30fc\u30fb\u30a8\u30b9'\n```\n\nNon alphabet letters are not convert (default).  \nUpper case letters has (CAPS) or (\u5927\u6587\u5b57) sign (default).\n```python\n>>> conv_al('Examples002')\n'Echo(CAPS)-Xray-Alfa-Mike-Papa-Lima-Echo-Sierra-0-0-2'\n>>> conv_ak('Examples002')\n'\u30a4\u30fc\uff08\u5927\u6587\u5b57\uff09\u30fb\u30a8\u30af\u30b9\u30fb\u30a8\u30a4\u30fb\u30a8\u30e0\u30fb\u30d4\u30fc\u30fb\u30a8\u30eb\u30fb\u30a4\u30fc\u30fb\u30a8\u30b9\u30fb0\u30fb0\u30fb2'\n```\n\nYou can change delimiter and Upper case letters sign.\n```python\n>>> conv_al('Examples003', delimiter=', ', sign='(CAPITAL)')\n'Echo(CAPITAL), Xray, Alfa, Mike, Papa, Lima, Echo, Sierra, 0, 0, 3'\n>>> conv_ak('Examples003', delimiter='\uff0f', sign='(\u5927)')\n'\u30a4\u30fc(\u5927)\uff0f\u30a8\u30af\u30b9\uff0f\u30a8\u30a4\uff0f\u30a8\u30e0\uff0f\u30d4\u30fc\uff0f\u30a8\u30eb\uff0f\u30a4\u30fc\uff0f\u30a8\u30b9\uff0f0\uff0f0\uff0f3'\n```\n\nIf you would like to convert numbers to phonetic code, set `num=True`.\n```python\n>>> conv_al('Examples004', num=True)\n'Echo(CAPS)-Xray-Alfa-Mike-Papa-Lima-Echo-Sierra-zero-zero-four'\n>>> conv_ak('Examples004', num=True)\n'\u30a4\u30fc\uff08\u5927\u6587\u5b57\uff09\u30fb\u30a8\u30af\u30b9\u30fb\u30a8\u30a4\u30fb\u30a8\u30e0\u30fb\u30d4\u30fc\u30fb\u30a8\u30eb\u30fb\u30a4\u30fc\u30fb\u30a8\u30b9\u30fb\u30bc\u30ed\u30fb\u30bc\u30ed\u30fb\u30e8\u30f3'\n```\n\n## Development and Release\n\n### Setting up for development\n\n```bash\n# Clone the repository\ngit clone https://github.com/kacchan822/a2pcej.git\ncd a2pcej\n\n# Install in development mode\npip install -e .[dev]\n\n# Run tests\npytest tests/ -v\n\n# Format code\nblack .\nisort .\n\n# Lint code\nflake8 .\n```\n\n### Release Process\n\nThis project uses automated releases via GitHub Actions. To create a new release:\n\n1. Update the version information and commit your changes\n2. Create and push a tag:\n   ```bash\n   git tag v1.0.0  # Replace with your version\n   git push origin v1.0.0\n   ```\n3. GitHub Actions will automatically:\n   - Run tests across multiple Python versions\n   - Build the package\n   - Publish to PyPI\n\n### GitHub Actions Setup\n\nTo enable automatic PyPI publishing, you need to set up authentication:\n\n#### Option 1: PyPI API Token (Traditional)\n1. Create an API token on PyPI\n2. Add it as `PYPI_API_TOKEN` in GitHub repository secrets\n\n#### Option 2: Trusted Publishing (Recommended)\n1. Configure Trusted Publishing on PyPI for this repository\n2. No secrets needed - uses OpenID Connect (OIDC)\n\nFor more details, see the [PyPI documentation on Trusted Publishing](https://docs.pypi.org/trusted-publishers/).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "a2pcej, convert Alphabet to Phonetic Code in English and Japanese.",
    "version": "0.2.4",
    "project_urls": {
        "Homepage": "https://github.com/kacchan822/a2pcej",
        "Issues": "https://github.com/kacchan822/a2pcej/issues",
        "Repository": "https://github.com/kacchan822/a2pcej"
    },
    "split_keywords": [
        "alphabet",
        " katakana",
        " phonetic code"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ae87736baddc057ff19867a34e1868679de15ae4cdd348b24a7585abfec8381a",
                "md5": "6799143261ce8bbfa2e519f7973f6f78",
                "sha256": "3c3b4b93332765143eefc2b3d74e2edab4d20de0041d01f6372bd8850a014b4d"
            },
            "downloads": -1,
            "filename": "a2pcej-0.2.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6799143261ce8bbfa2e519f7973f6f78",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7205,
            "upload_time": "2025-08-20T06:22:20",
            "upload_time_iso_8601": "2025-08-20T06:22:20.678819Z",
            "url": "https://files.pythonhosted.org/packages/ae/87/736baddc057ff19867a34e1868679de15ae4cdd348b24a7585abfec8381a/a2pcej-0.2.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1751464613eb079211e9b0265b1d37ea7b0fd6274a47b8cd9bdea6c2f6f16ed9",
                "md5": "4644b367e1f1375103e06e0a996d3c27",
                "sha256": "a895d48918f3c76a6db7768214cb7b95eaf8071d7af16d71478b27268f487f9c"
            },
            "downloads": -1,
            "filename": "a2pcej-0.2.4.tar.gz",
            "has_sig": false,
            "md5_digest": "4644b367e1f1375103e06e0a996d3c27",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 9791,
            "upload_time": "2025-08-20T06:22:22",
            "upload_time_iso_8601": "2025-08-20T06:22:22.098623Z",
            "url": "https://files.pythonhosted.org/packages/17/51/464613eb079211e9b0265b1d37ea7b0fd6274a47b8cd9bdea6c2f6f16ed9/a2pcej-0.2.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-20 06:22:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kacchan822",
    "github_project": "a2pcej",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "a2pcej"
}
        
Elapsed time: 1.02101s