{
    "info": {
        "author": "Jacob Shiohira",
        "author_email": "shiohira.jacob@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: BSD License",
            "Programming Language :: Python :: 3"
        ],
        "description": "# Japanese Verb Conjugator\n\nJapanese Verb Conjugator is a Python library for conjugating Japanese verbs. \n\n### What forms will Japanese Verb Conjugator conjugate?\n\nJapanese Verb Conjugator conjugates the following verb forms:\n\n* plain form\n* polite form\n* ~te form\n* conditional form\n* volitional form\n* potential form\n* imperative form\n* provisional form\n* causative form\n* passive form\n\nJapanese Verb Conjugator conjugates verbs based on `verb class`, `tense`, `formality`, and `polarity` parameters. Depending on the conjugation and [verb class](https://wtawa.people.amherst.edu/jvrules/index.php?form=groups), the parameters for conjugation methods may vary. \n\n**Example**\n\n`generate_plain_form` requires `verb class`, `tense`, and `formality` parameters.\n\n`generate_volitional_form` requires `verb class`, `tense`, and `polarity` parameters.\n\n## Installation\n\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install `japaneseverbconjugator`. If you want to install `japaneseverbconjugator` and its dependencies in a virtual environment, first create and activiate a virtual environment. If you want to change the virtual environment name to someting other than `venv`, replace the second `venv` with your desired name. Use that same name to replace `venv` in the second command.\n\n```python\npython3 -m venv venv\nsource venv/bin/activate\n```\n\nIf you run into trouble, see the [Python Virtual Environment tutorial](https://docs.python.org/3/tutorial/venv.html). \n\n### Method 1: Pip\nAfter installing and activating the virtual environment, run the following commands to install `japaneseverbconjugator` and its dependencies.\n\n```bash\npip install japaneseverbconjugator\n```\n#### Note\nPip may display an error during installation that includes the following message. \n\n```\nNo matching distribution found for romkan (from JapaneseVerbConjugator)\n```\n\nIn this case, run the command `pip install romkan` and then run `pip install japaneseverbconjugator` again.\n\nYou should be good to go! See the **Usage** section on how to get started using the library.\n\n### Method 2: Clone this repository\n\nGo to the directory you want to clone this repository and run the following command.\n\n```bash\ngit clone https://github.com/jShiohaha/JapaneseVerbConjugator.git\n```\n\nAfter installing the library, install the library dependencies via pip with the following command. The dependencies in `requirements.txt` will allow you to run the library and tests.\n\n```bash\npip install -r requirements.txt\n```\n\nYou should be good to go! See the **Usage** section on how to get started using the library.\n\n## Usage\n\nHere is an example of how to import the library and use it.\n\n```python\nfrom japaneseverbconjugator.src import JapaneseVerbFormGenerator as japaneseVerbFormGenerator\nfrom japaneseverbconjugator.src.constants.EnumeratedTypes import VerbClass, Tense, Polarity\n\njvfg = japaneseVerbFormGenerator.JapaneseVerbFormGenerator() # creates JapaneseVerbFormGenerator instance\njvfg.generate_plain_form(\"\u98f2\u3080\", VerbClass.GODAN, Tense.NONPAST, Polarity.POSTIIVE) # returns '\u98f2\u3080'\njvfg.generate_plain_form(\"\u98f2\u3080\", VerbClass.GODAN, Tense.NONPAST, Polarity.NEGATIVE) # returns '\u98f2\u307e\u306a\u3044'\n```\n\nThe library will try to help validate the correctness of the verb by checking for invalid verb lengths, non-Japanese characters, and invalid verb endings. **Limitation**: this library cannot identify Chinese words with valid Japanese particle endings or nonexistent Japanese verbs.\n\n## Tests\n\nRunning tests should be done from `japaneseverbsconjugator` directory. Otherwise, you will get errors saying that Python cannot find certain modules needed for import.\n\nThe script named `RunTests.sh` makes it easy to run all the tests for this library. This repository includes the `coverage` package to track code coverage, and `RunTests.sh` will use this package if you instruct it to do so.\n\n#### Run tests and view HTML coverage report\n\nUse the following commands to run the tests and see the HTML coverage report in a browser.\n\n```bash\n./RunTests.sh html\n```\n\n**Note**: If this doesn't work, you can manually create and open the report with the following commands.\n\n```bash\ncoverage html\nopen htmlcov/index.html\n```\n\n#### Run tests and view command line coverage report\n\nUse the following commands to run the tests and see the coverage report on command line.\n\n```bash\n./RunTests.sh report\n```\n\n#### Run tests\n\nUse the following commands to only run the tests with the `unittest` framework.\n\n```bash\n./RunTests.sh\n```\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\nThis project uses a Python package named `romkan`, which has a BSD license. This project therefore has a [BSD](https://choosealicense.com/licenses/bsd/) license.\n\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/jShiohaha/JapaneseVerbConjugator/",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "JapaneseVerbConjugator",
        "package_url": "https://pypi.org/project/JapaneseVerbConjugator/",
        "platform": "",
        "project_url": "https://pypi.org/project/JapaneseVerbConjugator/",
        "project_urls": {
            "Homepage": "https://github.com/jShiohaha/JapaneseVerbConjugator/"
        },
        "release_url": "https://pypi.org/project/JapaneseVerbConjugator/1.0.1/",
        "requires_dist": [
            "romkan"
        ],
        "requires_python": "",
        "summary": "Japanese verb Conjugator",
        "version": "1.0.1"
    },
    "last_serial": 4773359,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ec056ea607aea045cbc5759ac4c7f47d",
                    "sha256": "7b3d4720450233f62a6c0429e7d2e9353159826a69363858f88feb0bcf258551"
                },
                "downloads": -1,
                "filename": "JapaneseVerbConjugator-1.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "ec056ea607aea045cbc5759ac4c7f47d",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 24746,
                "upload_time": "2019-02-02T21:48:36",
                "url": "https://files.pythonhosted.org/packages/79/14/f3c6a6481edfc823be8631b044e6803b964f74f2610deb3c74cdf87cedaf/JapaneseVerbConjugator-1.0.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "87f704b3d3aa0150a3632df4e540f878",
                    "sha256": "447c784660fefb75c93cb1be67edcd44630c0974386b48bbc4306165c104dfe1"
                },
                "downloads": -1,
                "filename": "JapaneseVerbConjugator-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "87f704b3d3aa0150a3632df4e540f878",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11826,
                "upload_time": "2019-02-02T21:48:38",
                "url": "https://files.pythonhosted.org/packages/02/68/149edc095f0f2cfa6980696e882ab8ee9a58c1e8b764d78164f2bf18cf4a/JapaneseVerbConjugator-1.0.0.tar.gz"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1591576a8fe56dd776a6d98b87ecc10e",
                    "sha256": "b86aaaa9ba1fc61ff67a4f09e51b9218f13f2b5a9cc0dbd7b6bfe2452da89979"
                },
                "downloads": -1,
                "filename": "JapaneseVerbConjugator-1.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "1591576a8fe56dd776a6d98b87ecc10e",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 26399,
                "upload_time": "2019-02-02T22:42:32",
                "url": "https://files.pythonhosted.org/packages/ff/4d/05fae635546681c9e1ddd57eab8c7502a574b3fbed4017a96c5bc5d38c6b/JapaneseVerbConjugator-1.0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "ceb1750dcf04caad3c55de5fe6004a6f",
                    "sha256": "fbda9bb378692fb0b28fb8689f4a5ce104901756ac54749c61c6e2806b31ae00"
                },
                "downloads": -1,
                "filename": "JapaneseVerbConjugator-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "ceb1750dcf04caad3c55de5fe6004a6f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13759,
                "upload_time": "2019-02-02T22:42:34",
                "url": "https://files.pythonhosted.org/packages/18/6c/8308e009dbed7f208acd85e791c744e1a7f64a93de23052c98db81be96ef/JapaneseVerbConjugator-1.0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "1591576a8fe56dd776a6d98b87ecc10e",
                "sha256": "b86aaaa9ba1fc61ff67a4f09e51b9218f13f2b5a9cc0dbd7b6bfe2452da89979"
            },
            "downloads": -1,
            "filename": "JapaneseVerbConjugator-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1591576a8fe56dd776a6d98b87ecc10e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 26399,
            "upload_time": "2019-02-02T22:42:32",
            "url": "https://files.pythonhosted.org/packages/ff/4d/05fae635546681c9e1ddd57eab8c7502a574b3fbed4017a96c5bc5d38c6b/JapaneseVerbConjugator-1.0.1-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "ceb1750dcf04caad3c55de5fe6004a6f",
                "sha256": "fbda9bb378692fb0b28fb8689f4a5ce104901756ac54749c61c6e2806b31ae00"
            },
            "downloads": -1,
            "filename": "JapaneseVerbConjugator-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ceb1750dcf04caad3c55de5fe6004a6f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 13759,
            "upload_time": "2019-02-02T22:42:34",
            "url": "https://files.pythonhosted.org/packages/18/6c/8308e009dbed7f208acd85e791c744e1a7f64a93de23052c98db81be96ef/JapaneseVerbConjugator-1.0.1.tar.gz"
        }
    ]
}