# Wordle Solver
This project provides a Wordle solver that can be used as a command-line interface (CLI) tool or imported as a module in your Python code. SOWPODS is used as lexicon.
Suggests new words that are most likely to reduce the total results. Can filter current list of words with
## Installation
### PyPI
```
pip install fwordlesolver
```
### Manually
Clone the repository and navigate to the project directory:
```sh
git clone https://github.com/fmakdemir/fwordlesolver.git
cd fwordlesolver
```
Install Poetry if you haven't already. You can find the installation guide [here](https://python-poetry.org/docs/#installation).
Install the required dependencies using Poetry:
```sh
poetry install
```
## Usage
### Running as CLI
You can run the Wordle solver from the command line. Use the following command:
```sh
poetry run f-wordle-solver --word-size 6
```
You can select the size of the word with
### Importing and Using the Solver
You can also import the solver into your Python code:
```python
from fwordlesolver.solver import WordleSolver
solver = WordleSolver(6)
print(solver.get_suggestions())
solver.filter_word('blinks', '.x..x.')
print(solver.get_suggestions())
```
### Running Tests
This package uses [pytest](https://docs.pytest.org/) for running tests.
To run the tests, use the following command:
```sh
pytest
```
This will execute all the test cases in the `tests` directory.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/fmakdemir/wordle-solver",
"name": "fwordlesolver",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "wordle, word, solver, cli, library",
"author": "Fma",
"author_email": "info@fmakdemir.com",
"download_url": "https://files.pythonhosted.org/packages/e3/cf/a3993e3523e80d4dec3a7067ec9ee3572b7163bae7b31aac5ad1f8343872/fwordlesolver-0.4.7.tar.gz",
"platform": null,
"description": "# Wordle Solver\n\nThis project provides a Wordle solver that can be used as a command-line interface (CLI) tool or imported as a module in your Python code. SOWPODS is used as lexicon.\n\nSuggests new words that are most likely to reduce the total results. Can filter current list of words with\n\n## Installation\n\n### PyPI\n\n```\npip install fwordlesolver\n```\n\n### Manually\nClone the repository and navigate to the project directory:\n\n```sh\ngit clone https://github.com/fmakdemir/fwordlesolver.git\ncd fwordlesolver\n```\n\nInstall Poetry if you haven't already. You can find the installation guide [here](https://python-poetry.org/docs/#installation).\n\nInstall the required dependencies using Poetry:\n\n```sh\npoetry install\n```\n\n## Usage\n\n### Running as CLI\n\nYou can run the Wordle solver from the command line. Use the following command:\n\n```sh\npoetry run f-wordle-solver --word-size 6\n```\n\nYou can select the size of the word with\n\n### Importing and Using the Solver\n\nYou can also import the solver into your Python code:\n\n```python\nfrom fwordlesolver.solver import WordleSolver\n\nsolver = WordleSolver(6)\nprint(solver.get_suggestions())\n\nsolver.filter_word('blinks', '.x..x.')\nprint(solver.get_suggestions())\n```\n\n### Running Tests\n\nThis package uses [pytest](https://docs.pytest.org/) for running tests.\n\nTo run the tests, use the following command:\n\n```sh\npytest\n```\n\nThis will execute all the test cases in the `tests` directory.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Word puzzle solver library and CLI",
"version": "0.4.7",
"project_urls": {
"Bug Tracker": "https://github.com/fmakdemir/wordle-solver/issues",
"Documentation": "https://github.com/fmakdemir/wordle-solver",
"Homepage": "https://github.com/fmakdemir/wordle-solver",
"Repository": "https://github.com/fmakdemir/wordle-solver"
},
"split_keywords": [
"wordle",
" word",
" solver",
" cli",
" library"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "862181795b02da5f15af67a3df477ba4752554b82e4c8892fbf04a59203a4d2a",
"md5": "56c4b9d5be40ad68b909bd749c21f49a",
"sha256": "5ae3851a99d594e70bd8cd1012edfdb1f583c29ee8e50c1b7939c4f6ec2b6974"
},
"downloads": -1,
"filename": "fwordlesolver-0.4.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "56c4b9d5be40ad68b909bd749c21f49a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 697979,
"upload_time": "2025-02-08T21:54:52",
"upload_time_iso_8601": "2025-02-08T21:54:52.079285Z",
"url": "https://files.pythonhosted.org/packages/86/21/81795b02da5f15af67a3df477ba4752554b82e4c8892fbf04a59203a4d2a/fwordlesolver-0.4.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e3cfa3993e3523e80d4dec3a7067ec9ee3572b7163bae7b31aac5ad1f8343872",
"md5": "60cfbc066abaca86ddf6bc95358b942a",
"sha256": "fef8e99c35dabf11557a06249dd3c080b3a3c40694d57934f442be550a965211"
},
"downloads": -1,
"filename": "fwordlesolver-0.4.7.tar.gz",
"has_sig": false,
"md5_digest": "60cfbc066abaca86ddf6bc95358b942a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 698254,
"upload_time": "2025-02-08T21:54:54",
"upload_time_iso_8601": "2025-02-08T21:54:54.151727Z",
"url": "https://files.pythonhosted.org/packages/e3/cf/a3993e3523e80d4dec3a7067ec9ee3572b7163bae7b31aac5ad1f8343872/fwordlesolver-0.4.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-08 21:54:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fmakdemir",
"github_project": "wordle-solver",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fwordlesolver"
}
JSON
