JPFreq


NameJPFreq JSON
Version 0.4.0 PyPI version JSON
download
home_page
SummaryA Python module which allows for the easy frequency analysis of Japanese text
upload_time2023-09-06 04:12:05
maintainer
docs_urlNone
author
requires_python>=3.10
licenseMIT License Copyright (c) 2023 Marley Mulvin Broome Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords anime frequency japanese japanese learning japanese study language learning manga tool
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # JPFreq

![Tests](https://github.com/Marley-Mulvin-Broome/JapaneseFrequencyProcessor/actions/workflows/test.yaml/badge.svg)
![Docs](https://github.com/Marley-Mulvin-Broome/JapaneseFrequencyProcessor/actions/workflows/docs.yaml/badge.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![Code Style: Black](https://camo.githubusercontent.com/d91ed7ac7abbd5a6102cbe988dd8e9ac21bde0a73d97be7603b891ad08ce3479/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64652532307374796c652d626c61636b2d3030303030302e737667)
![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)


<!-- TOC -->
* [JPFreq](#jpfreq)
  * [Installation](#installation)
  * [Usage](#usage)
    * [Getting the most frequent words](#getting-the-most-frequent-words)
    * [Reading from a file](#reading-from-a-file)
<!-- TOC -->

JPFreq is a frequency processor for Japanese text. It uses the Cython wrapper for MeCab [Fugashi](https://github.com/polm/fugashi) 
to process Japanese text.

## Installation

1. Install Fugashi and Unidic
    ```bash
   pip install fugashi[unidic]
   python3 -m unidic download
    ```
2. Install JPFreq
    ```bash
    pip install jpfreq
    ```

## Usage

For detailed usage, see the [documentation](https://marley-mulvin-broome.github.io/JapaneseFrequencyProcessor/).

### Getting the most frequent words

```python
from jpfreq.jp_frequency_list import JapaneseFrequencyList

freq_list = JapaneseFrequencyList()
freq_list.process_line("私は猫です。")

print(freq_list.get_most_frequent())
```

### Reading from a file

```python
from jpfreq.jp_frequency_list import JapaneseFrequencyList

freq_list = JapaneseFrequencyList()
freq_list.process_file("path/to/file.txt")

print(freq_list.get_most_frequent())
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "JPFreq",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "Marley Mulvin Broome <marley.developer@gmail.com>",
    "keywords": "Anime,Frequency,Japanese,Japanese Learning,Japanese Study,Language Learning,Manga,Tool",
    "author": "",
    "author_email": "Marley Mulvin Broome <marley.developer@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/68/e5/0fafb1636da1486298b584eabccb81db5f8413811a5c65e14eb7b7b7985e/jpfreq-0.4.0.tar.gz",
    "platform": null,
    "description": "# JPFreq\n\n![Tests](https://github.com/Marley-Mulvin-Broome/JapaneseFrequencyProcessor/actions/workflows/test.yaml/badge.svg)\n![Docs](https://github.com/Marley-Mulvin-Broome/JapaneseFrequencyProcessor/actions/workflows/docs.yaml/badge.svg)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n![Code Style: Black](https://camo.githubusercontent.com/d91ed7ac7abbd5a6102cbe988dd8e9ac21bde0a73d97be7603b891ad08ce3479/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64652532307374796c652d626c61636b2d3030303030302e737667)\n![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)\n\n\n<!-- TOC -->\n* [JPFreq](#jpfreq)\n  * [Installation](#installation)\n  * [Usage](#usage)\n    * [Getting the most frequent words](#getting-the-most-frequent-words)\n    * [Reading from a file](#reading-from-a-file)\n<!-- TOC -->\n\nJPFreq is a frequency processor for Japanese text. It uses the Cython wrapper for MeCab [Fugashi](https://github.com/polm/fugashi) \nto process Japanese text.\n\n## Installation\n\n1. Install Fugashi and Unidic\n    ```bash\n   pip install fugashi[unidic]\n   python3 -m unidic download\n    ```\n2. Install JPFreq\n    ```bash\n    pip install jpfreq\n    ```\n\n## Usage\n\nFor detailed usage, see the [documentation](https://marley-mulvin-broome.github.io/JapaneseFrequencyProcessor/).\n\n### Getting the most frequent words\n\n```python\nfrom jpfreq.jp_frequency_list import JapaneseFrequencyList\n\nfreq_list = JapaneseFrequencyList()\nfreq_list.process_line(\"\u79c1\u306f\u732b\u3067\u3059\u3002\")\n\nprint(freq_list.get_most_frequent())\n```\n\n### Reading from a file\n\n```python\nfrom jpfreq.jp_frequency_list import JapaneseFrequencyList\n\nfreq_list = JapaneseFrequencyList()\nfreq_list.process_file(\"path/to/file.txt\")\n\nprint(freq_list.get_most_frequent())\n```\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Marley Mulvin Broome  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "A Python module which allows for the easy frequency analysis of Japanese text",
    "version": "0.4.0",
    "project_urls": {
        "Documentation": "https://marley-mulvin-broome.github.io/JapaneseFrequencyProcessor",
        "Homepage": "https://github.com/Marley-Mulvin-Broome/JapaneseFrequencyProcessor",
        "Source": "https://github.com/Marley-Mulvin-Broome/JapaneseFrequencyProcessor"
    },
    "split_keywords": [
        "anime",
        "frequency",
        "japanese",
        "japanese learning",
        "japanese study",
        "language learning",
        "manga",
        "tool"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9a545298d70a1bce3f5d4d6e72c4bb2405cf4ef124cb46bf4e12ac592f584877",
                "md5": "44a846872b7a897199322656f42f1e5e",
                "sha256": "3d070e1aae4e22816650f6ca274598c32225b2ed413d63f43434960b165045fb"
            },
            "downloads": -1,
            "filename": "jpfreq-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "44a846872b7a897199322656f42f1e5e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 14541,
            "upload_time": "2023-09-06T04:12:03",
            "upload_time_iso_8601": "2023-09-06T04:12:03.611677Z",
            "url": "https://files.pythonhosted.org/packages/9a/54/5298d70a1bce3f5d4d6e72c4bb2405cf4ef124cb46bf4e12ac592f584877/jpfreq-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "68e50fafb1636da1486298b584eabccb81db5f8413811a5c65e14eb7b7b7985e",
                "md5": "c5cec3d64b8348ab52c436a4029b375e",
                "sha256": "ae927217f06cfe621f1a36c71acb91e3e70877d5f53ac7dd2e2abbe5d5337d36"
            },
            "downloads": -1,
            "filename": "jpfreq-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c5cec3d64b8348ab52c436a4029b375e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 38614,
            "upload_time": "2023-09-06T04:12:05",
            "upload_time_iso_8601": "2023-09-06T04:12:05.231721Z",
            "url": "https://files.pythonhosted.org/packages/68/e5/0fafb1636da1486298b584eabccb81db5f8413811a5c65e14eb7b7b7985e/jpfreq-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-06 04:12:05",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Marley-Mulvin-Broome",
    "github_project": "JapaneseFrequencyProcessor",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "jpfreq"
}
        
Elapsed time: 0.10824s