Tenhou-Paifu-Logger


NameTenhou-Paifu-Logger JSON
Version 0.3.2 PyPI version JSON
download
home_page
SummaryLogging tenhou paifu into excel or html file with some key information.
upload_time2023-08-14 17:58:45
maintainer
docs_urlNone
author
requires_python>=3.9
licenseMIT License Copyright (c) 2023 Jim137 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 mahjong review logger paifu tenhou haifu paipu riichi-mahjong
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Tenhou Paifu Logger

[<img src="https://img.shields.io/pypi/v/Tenhou-Paifu-Logger?style=plastic"> <img src="https://img.shields.io/pypi/wheel/Tenhou-Paifu-Logger?style=plastic">](https://pypi.org/project/Tenhou-Paifu-Logger/) [<img src="https://img.shields.io/github/stars/Jim137/Tenhou-Paifu-Logger?style=plastic">](https://github.com/Jim137/Tenhou-Paifu-Logger/) [<img src="https://img.shields.io/github/downloads/Jim137/Tenhou-Paifu-Logger/total?style=plastic">](https://github.com/Jim137/Tenhou-Paifu-Logger/releases) ![GitHub](https://img.shields.io/github/license/Jim137/Tenhou-Paifu-Logger?style=plastic)

Logging tenhou paifu into excel or html file with some key information.

If you like this project, please leave a star. It will be a great encouragement for me. And if you have any suggestions, please feel free to create an issue.

[Downloads](https://github.com/Jim137/Tenhou-Paifu-Logger/releases/latest) | [中文說明](https://github.com/Jim137/Tenhou-Paifu-Logger/blob/master/READMEs/README_zh.md) | [日本語](https://github.com/Jim137/Tenhou-Paifu-Logger/blob/master/READMEs/README_ja.md)

## Usage

1. Download the project.

  >a. Download from github.

  >>i. Clone the repository or download the [latest release](https://github.com/Jim137/Tenhou-Paifu-Logger/releases/latest).

     git clone https://github.com/Jim137/Tenhou-Paifu-Logger.git

  >>ii. Copy the paifu URL from tenhou.net to clipboard.
  >>iii. Open `runlog-user.bat`.
    
  >b. Download from pypi.

  >>i. Open command line and type

    pip install Tenhou-Paifu-Logger

  >>ii. Copy the paifu URL from tenhou.net to clipboard. And type

    log -l [language] -o [output directory] [paifu URLs]

2. Once ![1675261153312](READMEs/image/README/1675261153312.png) appears, paste the paifu URL and press Enter.\
Note: In the latest version, you can input multiple URLs at once, separated by whatever you like. If you are lazy, you can just paste w/o anything.
3. After ![1675264143738](READMEs/image/README/1675264143738.png) appears, the paifu is successfully logged.
4. When ![1675261153312](READMEs/image/README/1675261153312.png) appears again, you can paste the next the URL.

## Features
* [x] Log paifu into excel or html file with some key information.
* [x] Distinguish Sanma(3p) and Yonma(4p) and log into separate sheets.
* [x] Skip duplicated paifu
* [x] Remake the paifu with URL already logged (-r, --remake). It will be useful when we updated the logging information in future.
* [x] Customized output directory (-o, --output)
* [x] Localization support (-l, --language)
  * [x] English: en
  * [x] Traditional Chinese: zh_tw
  * [x] Simplified Chinese: zh
  * [x] Japanese (ChatGPT): ja

## Information logged

* Game time
* Placing
* URL (for future use)
* Rate before the game

## Future features

* [ ] Add match replay for every round in html file
* [ ] The change of Rate
* [ ] Agari analysis
* [ ] Support Majsoul paifu
* [ ] GUI

## Contribute
We welcome all kinds of contributions, including but not limited to bug reports, pull requests, feature requests, documentation improvements, localizations...etc.

## License

[MIT](LICENSE)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "Tenhou-Paifu-Logger",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "mahjong,review,logger,paifu,tenhou,haifu,paipu,riichi-mahjong",
    "author": "",
    "author_email": "Jim137 <jim@mail.jim137.eu.org>",
    "download_url": "https://files.pythonhosted.org/packages/68/ac/2d702c3e0813459a082dce47f8ef769598f887d44ff26193eef29e817b94/Tenhou-Paifu-Logger-0.3.2.tar.gz",
    "platform": null,
    "description": "# Tenhou Paifu Logger\n\n[<img src=\"https://img.shields.io/pypi/v/Tenhou-Paifu-Logger?style=plastic\"> <img src=\"https://img.shields.io/pypi/wheel/Tenhou-Paifu-Logger?style=plastic\">](https://pypi.org/project/Tenhou-Paifu-Logger/) [<img src=\"https://img.shields.io/github/stars/Jim137/Tenhou-Paifu-Logger?style=plastic\">](https://github.com/Jim137/Tenhou-Paifu-Logger/) [<img src=\"https://img.shields.io/github/downloads/Jim137/Tenhou-Paifu-Logger/total?style=plastic\">](https://github.com/Jim137/Tenhou-Paifu-Logger/releases) ![GitHub](https://img.shields.io/github/license/Jim137/Tenhou-Paifu-Logger?style=plastic)\n\nLogging tenhou paifu into excel or html file with some key information.\n\nIf you like this project, please leave a star. It will be a great encouragement for me. And if you have any suggestions, please feel free to create an issue.\n\n[Downloads](https://github.com/Jim137/Tenhou-Paifu-Logger/releases/latest) | [\u4e2d\u6587\u8aaa\u660e](https://github.com/Jim137/Tenhou-Paifu-Logger/blob/master/READMEs/README_zh.md) | [\u65e5\u672c\u8a9e](https://github.com/Jim137/Tenhou-Paifu-Logger/blob/master/READMEs/README_ja.md)\n\n## Usage\n\n1. Download the project.\n\n  >a. Download from github.\n\n  >>i. Clone the repository or download the [latest release](https://github.com/Jim137/Tenhou-Paifu-Logger/releases/latest).\n\n     git clone https://github.com/Jim137/Tenhou-Paifu-Logger.git\n\n  >>ii. Copy the paifu URL from tenhou.net to clipboard.\n  >>iii. Open `runlog-user.bat`.\n    \n  >b. Download from pypi.\n\n  >>i. Open command line and type\n\n    pip install Tenhou-Paifu-Logger\n\n  >>ii. Copy the paifu URL from tenhou.net to clipboard. And type\n\n    log -l [language] -o [output directory] [paifu URLs]\n\n2. Once ![1675261153312](READMEs/image/README/1675261153312.png) appears, paste the paifu URL and press Enter.\\\nNote: In the latest version, you can input multiple URLs at once, separated by whatever you like. If you are lazy, you can just paste w/o anything.\n3. After ![1675264143738](READMEs/image/README/1675264143738.png) appears, the paifu is successfully logged.\n4. When ![1675261153312](READMEs/image/README/1675261153312.png) appears again, you can paste the next the URL.\n\n## Features\n* [x] Log paifu into excel or html file with some key information.\n* [x] Distinguish Sanma(3p) and Yonma(4p) and log into separate sheets.\n* [x] Skip duplicated paifu\n* [x] Remake the paifu with URL already logged (-r, --remake). It will be useful when we updated the logging information in future.\n* [x] Customized output directory (-o, --output)\n* [x] Localization support (-l, --language)\n  * [x] English: en\n  * [x] Traditional Chinese: zh_tw\n  * [x] Simplified Chinese: zh\n  * [x] Japanese (ChatGPT): ja\n\n## Information logged\n\n* Game time\n* Placing\n* URL (for future use)\n* Rate before the game\n\n## Future features\n\n* [ ] Add match replay for every round in html file\n* [ ] The change of Rate\n* [ ] Agari analysis\n* [ ] Support Majsoul paifu\n* [ ] GUI\n\n## Contribute\nWe welcome all kinds of contributions, including but not limited to bug reports, pull requests, feature requests, documentation improvements, localizations...etc.\n\n## License\n\n[MIT](LICENSE)\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Jim137  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": "Logging tenhou paifu into excel or html file with some key information.",
    "version": "0.3.2",
    "project_urls": {
        "Homepage": "https://github.com/Jim137/Tenhou-Paifu-Logger"
    },
    "split_keywords": [
        "mahjong",
        "review",
        "logger",
        "paifu",
        "tenhou",
        "haifu",
        "paipu",
        "riichi-mahjong"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "45eb9bfb09b04ce1f75d9b4082c6eb4be93f4882b927fe6dd6cad681d4a2966e",
                "md5": "3a073636817ecdffe872ee70f9acee1b",
                "sha256": "91ef955a9f90fa6124c2e4b6c984058c3a2271f3deab2371211fa59e1a5b6f44"
            },
            "downloads": -1,
            "filename": "Tenhou_Paifu_Logger-0.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3a073636817ecdffe872ee70f9acee1b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 14199,
            "upload_time": "2023-08-14T17:58:43",
            "upload_time_iso_8601": "2023-08-14T17:58:43.872761Z",
            "url": "https://files.pythonhosted.org/packages/45/eb/9bfb09b04ce1f75d9b4082c6eb4be93f4882b927fe6dd6cad681d4a2966e/Tenhou_Paifu_Logger-0.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "68ac2d702c3e0813459a082dce47f8ef769598f887d44ff26193eef29e817b94",
                "md5": "ae387a9f072a8a83493a94b8d2b4bd12",
                "sha256": "1f999a839962f51f0edd557b4ed4e854190ae9307a6a29d266c098140fcc6e70"
            },
            "downloads": -1,
            "filename": "Tenhou-Paifu-Logger-0.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "ae387a9f072a8a83493a94b8d2b4bd12",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 9322,
            "upload_time": "2023-08-14T17:58:45",
            "upload_time_iso_8601": "2023-08-14T17:58:45.352441Z",
            "url": "https://files.pythonhosted.org/packages/68/ac/2d702c3e0813459a082dce47f8ef769598f887d44ff26193eef29e817b94/Tenhou-Paifu-Logger-0.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-14 17:58:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Jim137",
    "github_project": "Tenhou-Paifu-Logger",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "tenhou-paifu-logger"
}
        
Elapsed time: 0.11817s