{"id":13734671,"url":"https://github.com/MichaelAquilina/flake8-spellcheck","last_synced_at":"2025-05-08T10:32:47.742Z","repository":{"id":37821572,"uuid":"148219730","full_name":"MichaelAquilina/flake8-spellcheck","owner":"MichaelAquilina","description":"❄️ Spellcheck variables, classnames, comments, docstrings etc","archived":false,"fork":false,"pushed_at":"2024-08-27T14:50:13.000Z","size":1413,"stargazers_count":72,"open_issues_count":25,"forks_count":28,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-13T02:10:23.617Z","etag":null,"topics":["linter","python","spellcheck"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MichaelAquilina.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-10T21:11:12.000Z","updated_at":"2024-09-11T16:41:45.000Z","dependencies_parsed_at":"2024-01-06T09:59:23.148Z","dependency_job_id":"3f3c7351-9159-4852-9a9e-eb5aa96faf62","html_url":"https://github.com/MichaelAquilina/flake8-spellcheck","commit_stats":{"total_commits":213,"total_committers":20,"mean_commits":10.65,"dds":0.2863849765258216,"last_synced_commit":"3349852a93c9b7529be056858543177597476ed7"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelAquilina%2Fflake8-spellcheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelAquilina%2Fflake8-spellcheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelAquilina%2Fflake8-spellcheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelAquilina%2Fflake8-spellcheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MichaelAquilina","download_url":"https://codeload.github.com/MichaelAquilina/flake8-spellcheck/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253046010,"owners_count":21845825,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["linter","python","spellcheck"],"created_at":"2024-08-03T03:00:58.714Z","updated_at":"2025-05-08T10:32:47.373Z","avatar_url":"https://github.com/MichaelAquilina.png","language":"Python","funding_links":[],"categories":["Docstrings"],"sub_categories":[],"readme":"=================\nFlake8 Spellcheck\n=================\n\n|CircleCI| |Black| |PyPi|\n\nFlake8 Plugin that spellchecks variables, functions, classes and other bits of your python code.\n\nYou can create an allowlist for words that are specific to your project simply by adding them a ``.spellcheck-allowlist`` file\nin the root of your project directory. Each word you add should be separated by a newline.\n\nSpelling is assumed to be in en_US.\n\nThis plugin supports python 3.8+\n\nCodes\n-----\n\n* SC100 - Spelling error in comments\n* SC200 - Spelling error in name (e.g. variable, function, class)\n\nEnable Django support\n---------------------\n\nYou can enable support for a Django dictionary by adding the following to your\nflake8 configuration (e.g. your ``.flake8`` file):\n\n.. code-block:: ini\n\n    [flake8]\n    dictionaries = en_US,python,technical,django\n\nEnable pandas support\n---------------------\n\nYou can enable support for pandas DataFrames by adding the following to your\nflake8 configuration (e.g. your ``.flake8`` file):\n\n.. code-block:: ini\n\n    [flake8]\n    dictionaries = en_US,python,technical,pandas\n\nSpecify Targets\n---------------\n\nBoth ``comments`` and ``names`` (variable names, function names...) are spellchecked by default.\nYou can specify what targets to spellcheck in your flake8 configuration (e.g. in your ``.flake8`` file):\n\n.. code-block:: ini\n\n   [flake8]\n   spellcheck-targets = comments\n\nThe above configuration would only spellcheck comments\n\n.. code-block:: ini\n\n   [flake8]\n   spellcheck-targets = names\n\nThe above configuration would only spellcheck names\n\nSpecify Allowlist\n---------------\n\nYou can specify a list of allowed words - spellcheck will then not raise errors when those\nwords are encountered. You can define the list of allowed words either as a file or as a\nconfiguration parameter.\n\nBy default, spellcheck will try to load a `.spellcheck-allowlist` file in the root of your\nproject. You can override the file name using the `--spellcheck-allowlist-file` CLI\nparameter, or in your flake8 configuration (e.g. in your ``.flake8`` file):\n\n.. code-block:: ini\n\n   [flake8]\n   spellcheck-allowlist-file = your-allowlist-file\n\nYou can also define the allowlist directly using the `--spellcheck-allowlist` CLI parameter\n(this takes a comma-separated list of words to allow) or using the flake8 configuration\n(e.g. in your ``.flake8`` file):\n\n.. code-block:: ini\n\n   [flake8]\n   spellcheck-allowlist = your, allowed, words\n\n\n\n\nIgnore Rules\n------------\n\n.. code-block:: ini\n\n   [flake8]\n   ignore = SC100, SC200\n\nContributing\n------------\n\nIf you have found word(s) which are listed as a spelling error but are actually correct terms used\nin python or in technical implementations (e.g. http), then you can very easily contribute by\nadding those word(s) to the appropriate dictionaries:\n\n* `python dictionary \u003cflake8_spellcheck/python.txt\u003e`_\n* `technical dictionary \u003cflake8_spellcheck/technical.txt\u003e`_\n* `django dictionary \u003cflake8_spellcheck/django.txt\u003e`_\n* `pandas dictionary \u003cflake8_spellcheck/pandas.txt\u003e`_\n\nBefore you submit a PR, it is recommended to run ``check-sorting.sh`` in the root of this repository,\nto verify that all the dictionary files are still sorted correctly. Sorting is enforced by CI, so\nyou'll need to make sure the files are sorted before your PR can be merged.\n\nDevelopment\n-----------\n\n* Install `poetry \u003chttps://github.com/python-poetry\u003e`__\n* Install `golang \u003chttps://go.dev/doc/install\u003e`__ (required by some of our pre-commit hooks)\n* Run ``poetry install``\n* Run ``poetry run pre-commit install --install-hooks``\n\nYou can run tests with ``poetry run pytest``.\n\n\n.. |CircleCI| image:: https://circleci.com/gh/MichaelAquilina/flake8-spellcheck.svg?style=svg\n   :target: https://circleci.com/gh/MichaelAquilina/flake8-spellcheck\n\n.. |PyPi| image:: https://badge.fury.io/py/flake8-spellcheck.svg\n   :target: https://badge.fury.io/py/flake8-spellcheck\n\n.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n   :target: https://github.com/psf/black\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMichaelAquilina%2Fflake8-spellcheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMichaelAquilina%2Fflake8-spellcheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMichaelAquilina%2Fflake8-spellcheck/lists"}