<div align="center">
# wordlemini
</div>
<div align="center">
![wordlemini preview image](./wordlemini/assets/images/banner.png)
![licence](https://img.shields.io/badge/licence-MIT-green?style=flat?logo=licence)
[![PyPI version](https://img.shields.io/pypi/v/wordlemini?style=flat-square)](https://pypi.org/project/wordlemini/)
[![Publish to PyPI.org](https://github.com/tomasvana10/wordlemini/actions/workflows/publish.yml/badge.svg)](https://github.com/tomasvana10/wordlemini/actions/workflows/publish.yml)
[![release](https://img.shields.io/github/v/release/tomasvana10/wordlemini?logo=github)](https://github.com/tomasvana10/wordlemini/releases/latest)
[![issues](https://img.shields.io/github/issues-raw/tomasvana10/wordlemini.svg?maxAge=25000)](https://github.com/tomasvana10/wordlemini/issues)
[![CodeQL](https://github.com/tomasvana10/wordlemini/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/tomasvana10/wordlemini/actions/workflows/github-code-scanning/codeql)
[![Tests](https://github.com/tomasvana10/wordlemini/actions/workflows/tox-tests.yml/badge.svg)](https://github.com/tomasvana10/wordlemini/actions/workflows/tox-tests.yml)
</div>
`wordlemini` is a TUI package that allows you to play wordle in the command-line using `Textual`.
- Download the latest source code [here](https://github.com/tomasvana10/wordlemini/releases/latest).
- Available languages: Czech, German, English, Spanish, French, Italian, Dutch, Portugese, Russian
### Installation
Install the package from PyPI (a virtual environment is recommended):
```
pip install wordlemini
```
Run the game:
```
wordlemini
```
### CLI
**arguments**
- config
- lang `<lang-code>` - Change the language.
- dark `<on/off>` - Turn dark mode or on off.
Example:
```
wordlemini config lang ru
```
- stats - View your stats, including your guess distribution and games played.
### Runtime dependencies
`textual` `platformdirs` `pycountry`
### Acknowledgements
[textual](https://textual.textualize.io/) - A Rapid Application Development framework for Python.
[platformdirs](https://pypi.org/project/platformdirs/) - Finding the right place to store user data, independent to the OS.
[pycountry](https://pypi.org/project/pycountry/) - ISO databases for languages
### Gallery
*Stats TUI*
![stats page](./wordlemini/assets/images/stats.png)
Raw data
{
"_id": null,
"home_page": null,
"name": "wordlemini",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "wordle, puzzle, command line interface, game",
"author": "Tomas Vana",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/78/5a/ad48d1ea9faebba2a38f2b92ed94e71d742d16c83d8bdd0ff7eb0fc35724/wordlemini-0.1.6.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# wordlemini\n\n</div>\n\n<div align=\"center\">\n\n![wordlemini preview image](./wordlemini/assets/images/banner.png)\n![licence](https://img.shields.io/badge/licence-MIT-green?style=flat?logo=licence)\n[![PyPI version](https://img.shields.io/pypi/v/wordlemini?style=flat-square)](https://pypi.org/project/wordlemini/)\n[![Publish to PyPI.org](https://github.com/tomasvana10/wordlemini/actions/workflows/publish.yml/badge.svg)](https://github.com/tomasvana10/wordlemini/actions/workflows/publish.yml)\n[![release](https://img.shields.io/github/v/release/tomasvana10/wordlemini?logo=github)](https://github.com/tomasvana10/wordlemini/releases/latest)\n[![issues](https://img.shields.io/github/issues-raw/tomasvana10/wordlemini.svg?maxAge=25000)](https://github.com/tomasvana10/wordlemini/issues)\n[![CodeQL](https://github.com/tomasvana10/wordlemini/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/tomasvana10/wordlemini/actions/workflows/github-code-scanning/codeql)\n[![Tests](https://github.com/tomasvana10/wordlemini/actions/workflows/tox-tests.yml/badge.svg)](https://github.com/tomasvana10/wordlemini/actions/workflows/tox-tests.yml)\n\n</div>\n\n`wordlemini` is a TUI package that allows you to play wordle in the command-line using `Textual`.\n\n- Download the latest source code [here](https://github.com/tomasvana10/wordlemini/releases/latest).\n- Available languages: Czech, German, English, Spanish, French, Italian, Dutch, Portugese, Russian\n\n### Installation\nInstall the package from PyPI (a virtual environment is recommended):\n```\npip install wordlemini\n```\n\nRun the game:\n```\nwordlemini\n```\n\n### CLI\n**arguments**\n\n- config\n - lang `<lang-code>` - Change the language.\n - dark `<on/off>` - Turn dark mode or on off.\n\nExample: \n```\nwordlemini config lang ru\n```\n\n- stats - View your stats, including your guess distribution and games played.\n\n### Runtime dependencies\n`textual` `platformdirs` `pycountry`\n\n### Acknowledgements\n[textual](https://textual.textualize.io/) - A Rapid Application Development framework for Python.\n\n[platformdirs](https://pypi.org/project/platformdirs/) - Finding the right place to store user data, independent to the OS.\n\n[pycountry](https://pypi.org/project/pycountry/) - ISO databases for languages\n\n### Gallery\n*Stats TUI*\n\n![stats page](./wordlemini/assets/images/stats.png)\n",
"bugtrack_url": null,
"license": null,
"summary": "Wordle in the command-line",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://github.com/tomasvana10/wordlemini",
"Repository": "https://github.com/tomasvana10/wordlemini"
},
"split_keywords": [
"wordle",
" puzzle",
" command line interface",
" game"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bcbf2e60d75b4b8007e0189e33667d5216790429656c5ce6ef038915bee07334",
"md5": "87dfc2d595bfec252744913a3ad155cd",
"sha256": "7666a8df0a60bf94ce010ea1d32e37e3453fd4377584586c29bced625f6a411f"
},
"downloads": -1,
"filename": "wordlemini-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "87dfc2d595bfec252744913a3ad155cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 169435,
"upload_time": "2024-09-02T02:23:04",
"upload_time_iso_8601": "2024-09-02T02:23:04.993227Z",
"url": "https://files.pythonhosted.org/packages/bc/bf/2e60d75b4b8007e0189e33667d5216790429656c5ce6ef038915bee07334/wordlemini-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "785aad48d1ea9faebba2a38f2b92ed94e71d742d16c83d8bdd0ff7eb0fc35724",
"md5": "2aff06972d33dbcbeeb7e06a91ca7b96",
"sha256": "4e7fa324f3369a0d1d1e000de3db25c3705d61752beb2cc86073efee55f8a9c7"
},
"downloads": -1,
"filename": "wordlemini-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "2aff06972d33dbcbeeb7e06a91ca7b96",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 159005,
"upload_time": "2024-09-02T02:23:06",
"upload_time_iso_8601": "2024-09-02T02:23:06.607120Z",
"url": "https://files.pythonhosted.org/packages/78/5a/ad48d1ea9faebba2a38f2b92ed94e71d742d16c83d8bdd0ff7eb0fc35724/wordlemini-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-02 02:23:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tomasvana10",
"github_project": "wordlemini",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "textual",
"specs": []
},
{
"name": "platformdirs",
"specs": []
},
{
"name": "pycountry",
"specs": []
}
],
"lcname": "wordlemini"
}