py-fumen


Namepy-fumen JSON
Version 0.1.11 PyPI version JSON
download
home_pageNone
SummaryA package that replicates js fumen in python. More description on 'https://github.com/hsohliyt105/py-fumen'
upload_time2024-08-11 07:53:44
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # py-fumen
Python implementation of knewjade's fumen

# Installation 
Enter `pip install py-fumen` in terminal / cmd if you have python3 already.

# Uses
The usage of this package is very similar to the original fumen package.

## Decode
```
from py_fumen.decoder import decode

decode_pages = decode("v115@vhHJEJWPJyKJz/I1QJUNJvIJAgH")

for page in decode_pages:
    print(page.get_field().string())
```

## Encode
```
from py_fumen.encoder import encode
from py_fumen.field import Field, create_inner_field
from py_fumen.page import Page

pages = []
pages.append(
    Page(field=create_inner_field(Field.create(
        'LLL_____SS' +
        'LOO____SST' +
        'JOO___ZZTT' +
        'JJJ____ZZT',
        '__________',
    )),
    comment='Perfect Clear Opener'))

print(encode(pages))
```

# Difference between the knewjade's fumen
Some of functions and variables are non-private because of the disparity between python and typescript (e.g. quiz variable in the Quiz class).

Function and varibale names are changed with python naming convention.

create_inner_field function and create_new_inner_field are moved to field.py because of cross importing issue.

page.py is created for better OOP.

js_escape.py is added to imitate javascript's escape/unescape.

buffer.ts is renamed to fumen_buffer.py and Buffer object to FumenBuffer.

getters and setters are changed into methods (e.g. Page.get_field()). 

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "py-fumen",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "hsohliyt105 <hsohliyt105@naver.com>",
    "download_url": "https://files.pythonhosted.org/packages/db/8c/9d553a6596e2a94039a3fed92faba74d09730234a6b8396605dea2397caa/py_fumen-0.1.11.tar.gz",
    "platform": null,
    "description": "# py-fumen\nPython implementation of knewjade's fumen\n\n# Installation \nEnter `pip install py-fumen` in terminal / cmd if you have python3 already.\n\n# Uses\nThe usage of this package is very similar to the original fumen package.\n\n## Decode\n```\nfrom py_fumen.decoder import decode\n\ndecode_pages = decode(\"v115@vhHJEJWPJyKJz/I1QJUNJvIJAgH\")\n\nfor page in decode_pages:\n    print(page.get_field().string())\n```\n\n## Encode\n```\nfrom py_fumen.encoder import encode\nfrom py_fumen.field import Field, create_inner_field\nfrom py_fumen.page import Page\n\npages = []\npages.append(\n    Page(field=create_inner_field(Field.create(\n        'LLL_____SS' +\n        'LOO____SST' +\n        'JOO___ZZTT' +\n        'JJJ____ZZT',\n        '__________',\n    )),\n    comment='Perfect Clear Opener'))\n\nprint(encode(pages))\n```\n\n# Difference between the knewjade's fumen\nSome of functions and variables are non-private because of the disparity between python and typescript (e.g. quiz variable in the Quiz class).\n\nFunction and varibale names are changed with python naming convention.\n\ncreate_inner_field function and create_new_inner_field are moved to field.py because of cross importing issue.\n\npage.py is created for better OOP.\n\njs_escape.py is added to imitate javascript's escape/unescape.\n\nbuffer.ts is renamed to fumen_buffer.py and Buffer object to FumenBuffer.\n\ngetters and setters are changed into methods (e.g. Page.get_field()). \n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A package that replicates js fumen in python. More description on 'https://github.com/hsohliyt105/py-fumen'",
    "version": "0.1.11",
    "project_urls": {
        "Homepage": "https://github.com/hsohliyt105/py-fumen",
        "Issues": "https://github.com/hsohliyt105/py-fumen/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "40bc97d17c49fab86141b7beb3514b8a97de958762fbc11577f268987275e663",
                "md5": "210fbe2c86ce44f27f5e6365d5fb63b9",
                "sha256": "e5c57022b8aec455d7f2760f57d57d5f71c00ee84701a43ce74000dc09ad0658"
            },
            "downloads": -1,
            "filename": "py_fumen-0.1.11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "210fbe2c86ce44f27f5e6365d5fb63b9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 18055,
            "upload_time": "2024-08-11T07:53:43",
            "upload_time_iso_8601": "2024-08-11T07:53:43.158865Z",
            "url": "https://files.pythonhosted.org/packages/40/bc/97d17c49fab86141b7beb3514b8a97de958762fbc11577f268987275e663/py_fumen-0.1.11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "db8c9d553a6596e2a94039a3fed92faba74d09730234a6b8396605dea2397caa",
                "md5": "5aee680ec0df9d729d2126b995540165",
                "sha256": "33fdd4c24e032436ea7f78a019f78a8d3e6d0798074995b935ef24fa725cc363"
            },
            "downloads": -1,
            "filename": "py_fumen-0.1.11.tar.gz",
            "has_sig": false,
            "md5_digest": "5aee680ec0df9d729d2126b995540165",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 15805,
            "upload_time": "2024-08-11T07:53:44",
            "upload_time_iso_8601": "2024-08-11T07:53:44.186571Z",
            "url": "https://files.pythonhosted.org/packages/db/8c/9d553a6596e2a94039a3fed92faba74d09730234a6b8396605dea2397caa/py_fumen-0.1.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-11 07:53:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hsohliyt105",
    "github_project": "py-fumen",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "py-fumen"
}
        
Elapsed time: 0.93143s