{
    "info": {
        "author": "",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "Intended Audience :: Developers",
            "License :: OSI Approved",
            "Operating System :: MacOS",
            "Operating System :: Microsoft :: Windows",
            "Operating System :: POSIX",
            "Operating System :: Unix",
            "Programming Language :: Python",
            "Topic :: Software Development"
        ],
        "description": "codespell\n=========\n\nFix common misspellings in text files. It's designed primarily for checking\nmisspelled words in source code, but it can be used with other files as well.\n\nUseful links\n------------\n\n* `GitHub project <https://github.com/codespell-project/codespell>`_\n\n* Mailing list: <codespell@googlegroups.com> with web archives/interface\n  `here <https://groups.google.com/forum/?fromgroups#!forum/codespell>`_\n\n* `Repository <https://github.com/codespell-project/codespell>`_\n\n* `Releases <https://github.com/codespell-project/codespell/releases>`_\n\nRequirements\n------------\n\nPython 2.7 or above.\n\nInstallation\n------------\n\nYou can use ``pip`` to install codespell with e.g.::\n\n    pip install codespell\n\nUsage\n-----\n\nFor more in depth info please check usage with ``codespell -h``.\n\nSome noteworthy flags::\n\n    codespell -w, --write-changes\n\nThe -w flag will actually implement the changes recommended by codespell. Not running with ``-w`` flag is the same as with doing a dry run. It is recommended to run this with the ``-i`` or ``--interactive`` flag.::\n\n    codespell -I FILE, --ignore-words=FILE\n\nThe -I flag can be used to whitelist certain words that are in the ``codespell_lib/data/dictionary.txt``. The format of the whitelist file is one word per line. Invoke using: ``codespell -I path/to/file.txt`` to execute codespell referencing said whitelist. **Important note:** The whitelist passed to ``-I`` is case-sensitive based on how it is listed in ``dictionary.txt``. ::\n\n    codespell -L word1,word2,word3,word4\n\nThe -L flag can be used to whitelist certain words that are comma-separated placed immediately after it. ::\n\n    codespell -S, --skip=\n\nComma-separated list of files to skip. It accepts globs as well.  Examples:\n\n* to skip .eps & .txt files, invoke ``codespell --skip=\"*.eps,*.txt\"``\n\n* to skip directories, invoke ``codespell --skip=\"./src/3rd-Party,./src/Test\"``\n\n\nUseful commands::\n\n    codespell -d -q 3 --skip=\"*.po,*.ts,./src/3rdParty,./src/Test\"\n\nList all typos found except translation files and some directories.\nDisplay them without terminal colors and with a quiet level of 3. ::\n\n    codespell -i 3 -w\n\nRun interactive mode level 3 and write changes to file.\n\nWe ship a dictionary that is an improved version of the one available\n`on Wikipedia <https://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines>`_\nafter applying them in projects like Linux Kernel, EFL, oFono among others.\nYou can provide your own version of the dictionary, but patches for\nnew/different entries are very welcome.\n\nWant to know if a word you're proposing exists in codespell already? It is possible to test a word against the current dictionary that exists in ``codespell_lib/data/dictionary.txt`` via::\n\n    echo \"word\" | codespell -\n    echo \"1stword,2ndword\" | codespell -\n\nDictionary format\n-----------------\n\nThe format of the dictionary was influenced by the one it originally came from,\ni.e. from Wikipedia. The difference is how multiple options are treated and\nthat the last argument is the reason why a certain entry could not be applied\ndirectly, but instead be manually inspected. E.g.:\n\n1. Simple entry: one wrong word / one suggestion::\n\n        calulated->calculated\n\n2. Entry with more than one suggested fix::\n\n       fiel->feel, field, file, phial,\n\n   Note the last comma! You need to use it, otherwise the last suggestion\n   will be discarded (see below for why). When there is more than one\n   suggestion, an automatic fix is not possible and the best we can do is\n   to give the user the file and line where the error occurred as well as\n   the suggestions.\n\n3. Entry with one word, but with automatically fix disabled::\n\n       clas->class, disabled because of name clash in c++\n\n   Note that there isn't a comma in the end of the line. The last argument is\n   treated as the reason why a suggestion cannot be automatically applied.\n\nSending Pull Requests\n---------------------\n\nIf you have a suggested typo that you'd like to see merged please follow these steps:\n\n1. Make sure you read the instructions mentioned in the ``Dictionary format`` section above to submit correctly formatted entries.\n\n2. Sort the dictionary. This is done by invoking (in the top level directory of ``codespell/``)::\n\n       make check-dictionary\n\n   If the make script finds that you need to sort the dictionary, please then run::\n\n       make sort-dictionary\n\n3. Only after this process is complete do we recommend you submit the PR.\n\n**Important Notes:**\n\n* If the dictionary is submitted without being pre-sorted the PR will fail via TravisCI.\n* Not all PRs will be merged. This is pending on the discretion of the devs, maintainers, and the community.\n\nUpdating\n--------\n\nTo stay current with codespell developments it is possible to build codespell from GitHub via::\n\n    pip install --upgrade git+https://github.com/codespell-project/codespell.git\n\n**Important Notes:**\n\n* Sometimes installing via ``pip`` will complain about permissions. If this is the case then run with ::\n\n    pip install --user --upgrade git+https://github.com/codespell-project/codespell.git\n\n* It has been reported that after installing from ``pip``, codespell can't be located. Please check the $PATH variable to see if ``~/.local/bin`` is present. If it isn't then add it to your path.\n* If you decide to install via ``pip`` then be sure to remove any previously installed versions of codespell (via you OSs preferred app manager).\n\nUpdating the dictionary\n-----------------------\n\nIn the scenario where the user prefers not to follow the development version of codespell yet still opts to benefit from the frequently updated `dictionary.txt` file, we recommend running a simple set of commands to achieve this ::\n\n    wget https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt\n    codespell -D dictionary.txt\n\nThe above simply downloads the latest ``dictionary.txt`` file and then by utilizing the -D flag allows the user to specify the freshly downloaded ``dictionary.txt`` as the custom dictionary instead of the default one.\n\nLicense\n-------\n\nThe Python script ``codespell`` with its library ``codespell_lib`` is available\nwith the following terms:\n(*tl;dr*: `GPL v2`_)\n\n   Copyright (C) 2010-2011  Lucas De Marchi <lucas.de.marchi@gmail.com>\n\n   Copyright (C) 2011  ProFUSION embedded systems\n\n   This program is free software; you can redistribute it and/or modify\n   it under the terms of the GNU General Public License as published by\n   the Free Software Foundation; version 2 of the License.\n\n   This program is distributed in the hope that it will be useful,\n   but WITHOUT ANY WARRANTY; without even the implied warranty of\n   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n   GNU General Public License for more details.\n\n   You should have received a copy of the GNU General Public License\n   along with this program; if not, see\n   <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>.\n\n.. _GPL v2: http://www.gnu.org/licenses/old-licenses/gpl-2.0.html\n\ndictionary.txt is a derived work of English Wikipedia and is released under the\nCreative Commons Attribution-Share-Alike License 3.0\nhttp://creativecommons.org/licenses/by-sa/3.0/\n\n\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "https://github.com/codespell-project/codespell/",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/codespell-project/codespell/",
        "keywords": "",
        "license": "GPL v2",
        "maintainer": "Lucas De Marchi",
        "maintainer_email": "lucas.de.marchi@gmail.com",
        "name": "codespell",
        "package_url": "https://pypi.org/project/codespell/",
        "platform": "any",
        "project_url": "https://pypi.org/project/codespell/",
        "project_urls": {
            "Download": "https://github.com/codespell-project/codespell/",
            "Homepage": "https://github.com/codespell-project/codespell/"
        },
        "release_url": "https://pypi.org/project/codespell/1.16.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Codespell",
        "version": "1.16.0"
    },
    "last_serial": 5821226,
    "releases": {
        "1.10.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "13987888848a77f396858563a0926672",
                    "sha256": "00cb8610cde60b425d36efa61cf9131098f2f4d72ef39d2b68245cd6c83ba2e1"
                },
                "downloads": -1,
                "filename": "codespell-1.10.0.tar.gz",
                "has_sig": false,
                "md5_digest": "13987888848a77f396858563a0926672",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 46507,
                "upload_time": "2017-03-15T14:09:54",
                "url": "https://files.pythonhosted.org/packages/65/4f/650cf28666797ebc61aca1bfb768141712e32258c02215babef01e0c096d/codespell-1.10.0.tar.gz"
            }
        ],
        "1.11.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9bbdeef5e5d293d8254717f598785f31",
                    "sha256": "259ad215acc3b3406d65490224d70c6c85068b0b14d997728ed5b1d2ef275b6e"
                },
                "downloads": -1,
                "filename": "codespell-1.11.0.tar.gz",
                "has_sig": false,
                "md5_digest": "9bbdeef5e5d293d8254717f598785f31",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 53216,
                "upload_time": "2017-11-27T14:42:26",
                "url": "https://files.pythonhosted.org/packages/01/3d/f00eeb4b513ce5724366026a60867920a63d6d4362977bc18f05816ae740/codespell-1.11.0.tar.gz"
            }
        ],
        "1.12.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c03d86808cb3d4514b2a4e1d0d746a26",
                    "sha256": "f547ef6ea3af4569b0a4d3ef106ef6403f6ee574afdaa8e332650aea87301daf"
                },
                "downloads": -1,
                "filename": "codespell-1.12.0.tar.gz",
                "has_sig": false,
                "md5_digest": "c03d86808cb3d4514b2a4e1d0d746a26",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 70608,
                "upload_time": "2018-03-09T17:03:03",
                "url": "https://files.pythonhosted.org/packages/29/85/8098b4252e1ed5f39e9b83db96cd9105ef2572ba1a14a165f7023e86c766/codespell-1.12.0.tar.gz"
            }
        ],
        "1.13.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8acd8fb710820f9d67d6e747b6cc1ac6",
                    "sha256": "771b36e393e39d67829335b23a817e4cd08035d8b64048a9de60c6b178b38901"
                },
                "downloads": -1,
                "filename": "codespell-1.13.0.tar.gz",
                "has_sig": false,
                "md5_digest": "8acd8fb710820f9d67d6e747b6cc1ac6",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 87032,
                "upload_time": "2018-05-17T15:51:21",
                "url": "https://files.pythonhosted.org/packages/fa/75/b28d76bf412bc8e6253b10b7d148486d9e3395b3806a7301251eaaaa835e/codespell-1.13.0.tar.gz"
            }
        ],
        "1.14.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1a4a27b1757bc437ae362853939c4d4e",
                    "sha256": "b1b60867773ffc5643a3724b62d12fe6797aa735831733f8a45f6d28db5ef34f"
                },
                "downloads": -1,
                "filename": "codespell-1.14.0.tar.gz",
                "has_sig": false,
                "md5_digest": "1a4a27b1757bc437ae362853939c4d4e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 94724,
                "upload_time": "2018-10-03T15:51:08",
                "url": "https://files.pythonhosted.org/packages/b6/a0/954b77775d73c4943413d4aa486b8eb1a8864ea8e8941d55d4ce8e040b14/codespell-1.14.0.tar.gz"
            }
        ],
        "1.15.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1168b1b2886a47512f726e2a4fc77f2d",
                    "sha256": "8f1bc15ca4322b72213b1cf13eb437b3c3956e0f423ab414d294d7e77e0e4130"
                },
                "downloads": -1,
                "filename": "codespell-1.15.0.tar.gz",
                "has_sig": false,
                "md5_digest": "1168b1b2886a47512f726e2a4fc77f2d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 113617,
                "upload_time": "2019-05-17T18:11:59",
                "url": "https://files.pythonhosted.org/packages/84/92/0c864272b4db3f458a130ad732720c5607a88c0f7dd09fab1ad3234a1b4f/codespell-1.15.0.tar.gz"
            }
        ],
        "1.16.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7a745a6ac3a00c00b56670e21fe19084",
                    "sha256": "a81780122f955002d032a9a9c55e2305c6f252a530d8682ed5c3d0580f93d9b8"
                },
                "downloads": -1,
                "filename": "codespell-1.16.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "7a745a6ac3a00c00b56670e21fe19084",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 135798,
                "upload_time": "2019-09-12T15:46:54",
                "url": "https://files.pythonhosted.org/packages/e9/29/cde4ce66267954a24c0e4b222df3d84e68f00d50999554505050e230e630/codespell-1.16.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "f40c992c9ef483b628a03419fd2dffb0",
                    "sha256": "bf3b7c83327aefd26fe718527baa9bd61016e86db91a8123c0ef9c150fa02de9"
                },
                "downloads": -1,
                "filename": "codespell-1.16.0.tar.gz",
                "has_sig": false,
                "md5_digest": "f40c992c9ef483b628a03419fd2dffb0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 134239,
                "upload_time": "2019-09-12T15:46:57",
                "url": "https://files.pythonhosted.org/packages/df/6f/764ca059e0eb06b69e1abed2c9a2cabe7dac72b336e2600615b38ea547a3/codespell-1.16.0.tar.gz"
            }
        ],
        "1.9.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "343d40fa034499531951ea49a3860837",
                    "sha256": "c183af463c1776cba789b16438f3e278e2174f3cc3497b1c80d4b389799a9d2d"
                },
                "downloads": -1,
                "filename": "codespell-1.9.0.tar.gz",
                "has_sig": false,
                "md5_digest": "343d40fa034499531951ea49a3860837",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12009,
                "upload_time": "2016-06-09T18:50:18",
                "url": "https://files.pythonhosted.org/packages/bd/64/d16fc0b110dbe3567976980607eb1e89e5298f2e6704c2573d31886726c2/codespell-1.9.0.tar.gz"
            }
        ],
        "1.9.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e31c48805963851e1ea17e6a1129c815",
                    "sha256": "1ac74783b2e268470dfab0a8050425971dbc9e062e2f5e674531f0d53ec2efcb"
                },
                "downloads": -1,
                "filename": "codespell-1.9.1.tar.gz",
                "has_sig": false,
                "md5_digest": "e31c48805963851e1ea17e6a1129c815",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 44974,
                "upload_time": "2016-06-16T17:15:26",
                "url": "https://files.pythonhosted.org/packages/dd/48/fa9d476dfd2a7cf8a042bce16631994994d364d31f06ba58deda1d8fa224/codespell-1.9.1.tar.gz"
            }
        ],
        "1.9.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "33cb7e8808159b6d43e29f5f25ec07b6",
                    "sha256": "9cc7c27ce5a6bcf7fd38e7bd63399b8700604d67c4a396a9690a1778659768c4"
                },
                "downloads": -1,
                "filename": "codespell-1.9.2.tar.gz",
                "has_sig": false,
                "md5_digest": "33cb7e8808159b6d43e29f5f25ec07b6",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 45135,
                "upload_time": "2016-06-17T20:56:30",
                "url": "https://files.pythonhosted.org/packages/b7/0b/ecb6c421fe59c946bd97cb129165f91e333ddcd4681510fbc2f600116139/codespell-1.9.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "7a745a6ac3a00c00b56670e21fe19084",
                "sha256": "a81780122f955002d032a9a9c55e2305c6f252a530d8682ed5c3d0580f93d9b8"
            },
            "downloads": -1,
            "filename": "codespell-1.16.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7a745a6ac3a00c00b56670e21fe19084",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 135798,
            "upload_time": "2019-09-12T15:46:54",
            "url": "https://files.pythonhosted.org/packages/e9/29/cde4ce66267954a24c0e4b222df3d84e68f00d50999554505050e230e630/codespell-1.16.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f40c992c9ef483b628a03419fd2dffb0",
                "sha256": "bf3b7c83327aefd26fe718527baa9bd61016e86db91a8123c0ef9c150fa02de9"
            },
            "downloads": -1,
            "filename": "codespell-1.16.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f40c992c9ef483b628a03419fd2dffb0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 134239,
            "upload_time": "2019-09-12T15:46:57",
            "url": "https://files.pythonhosted.org/packages/df/6f/764ca059e0eb06b69e1abed2c9a2cabe7dac72b336e2600615b38ea547a3/codespell-1.16.0.tar.gz"
        }
    ]
}