piewordle


Namepiewordle JSON
Version 0.1.1 PyPI version JSON
download
home_page
SummaryA Recreation of Wordle in Python.
upload_time2024-02-18 18:21:34
maintainer
docs_urlNone
author
requires_python>=3.7
license
keywords games wordle word games english german cui crossplatform python terminal
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div id="top"></div>

<p>
   <a href="https://pepy.tech/project/piewordle/" alt="Downloads">
      <img src="https://static.pepy.tech/personalized-badge/piewordle?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Downloads" align="right">
   </a>
   <a href="https://pypi.org/project/piewordle/" alt="Visitors">
      <img src="https://visitor-badge.laobi.icu/badge?page_id=SilenZcience.PieWordle&right_color=orange" align="right">
   </a>
   <a href="https://github.com/SilenZcience/PieWordle/tree/main/piewordle" alt="CodeSize">
      <img src="https://img.shields.io/github/languages/code-size/SilenZcience/PieWordle?color=purple" align="right">
   </a>
</p>

[![OS-Windows]][OS-Windows]
[![OS-Linux]][OS-Linux]
[![OS-MacOS]][OS-MacOS]

<br/>
<div align="center">
<h2 align="center">PieWordle</h2>
   <p align="center">
      A Recreation of Wordle in Python.
      <br/>
      <a href="https://github.com/SilenZcience/PieWordle/blob/main/piewordle/wordle.py">
         <strong>Explore the code ยป</strong>
      </a>
      <br/>
      <br/>
      <a href="https://github.com/SilenZcience/PieWordle/issues">Report Bug</a>
      ยท
      <a href="https://github.com/SilenZcience/PieWordle/issues">Request Feature</a>
   </p>
</div>


<details>
   <summary>Table of Contents</summary>
   <ol>
      <li>
         <a href="#about-the-project">About The Project</a>
         <ul>
            <li><a href="#made-with">Made With</a></li>
         </ul>
      </li>
      <li>
         <a href="#getting-started">Getting Started</a>
         <ul>
            <li><a href="#prerequisites">Prerequisites</a></li>
            <li><a href="#installation">Installation</a></li>
         </ul>
      </li>
      <li><a href="#usage">Usage</a>
         <ul>
         <li><a href="#examples">Examples</a></li>
         </ul>
      </li>
      <li><a href="#license">License</a></li>
      <li><a href="#contact">Contact</a></li>
   </ol>
</details>

<div id="about-the-project"></div>

## About The Project




<div id="made-with"></div>

### Made With
[![MadeWith-Python]](https://www.python.org/)
[![Python][Python-Version]](https://www.python.org/)

<p align="right">(<a href="#top">back to top</a>)</p>
<div id="getting-started"></div>

## Getting Started

<div id="prerequisites"></div>

### Prerequisites

- Using PieWordle demands a Python-Interpreter (>= 3.7).

<div id="installation"></div>

### Installation
[![Version][CurrentVersion]](https://pypi.org/project/piewordle/)

Simply install the python package (via [PyPI-piewordle](https://pypi.org/project/piewordle/)):
```console
python -m pip install --upgrade piewordle
```

<p align="right">(<a href="#top">back to top</a>)</p>
<div id="usage"></div>

## Usage

```console
pwordle [OPTION]...
```

```console
options:
  -h, --help  show this help message and exit
  --daily     guess the daily wordle.
  -g GUESSES  define the amount of guesses the player has. default is 6.
  -?          allow not existing words.
  --de        use german words.
  -w WORDS    define custom wordle options. Seperator is ';'.
```

<div id="examples"></div>

### Examples

<details open>
	<summary><b>๐Ÿ“‚ Images ๐Ÿ“‚</b></summary>
   </br>

   <p float="left">
      <img src="https://raw.githubusercontent.com/SilenZcience/PieWordle/main/img/example1.png" width="49%"/>
      <img src="https://raw.githubusercontent.com/SilenZcience/PieWordle/main/img/example2.png" width="49%"/>
   </p>

</details>

```console
pwordle --daily -?
```

<p align="right">(<a href="#top">back to top</a>)</p>

<div id="license"></div>

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/SilenZcience/PieWordle/blob/main/LICENSE) file for details

<div id="contact"></div>

## Contact

> **SilenZcience** <br/>
[![GitHub-SilenZcience][GitHub-SilenZcience]](https://github.com/SilenZcience)

[OS-Windows]: https://img.shields.io/badge/os-windows-green
[OS-Linux]: https://img.shields.io/badge/os-linux-green
[OS-MacOS]: https://img.shields.io/badge/os-macOS-green


[MadeWith-Python]: https://img.shields.io/badge/Made%20with-Python-brightgreen
[Python-Version]: https://img.shields.io/badge/Python-3.7%20--%203.12%20%7C%20pypy--3.7%20--%20pypy--3.10-blue

[CurrentVersion]: https://img.shields.io/pypi/v/piewordle.svg

[GitHub-SilenZcience]: https://img.shields.io/badge/GitHub-SilenZcience-orange


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "piewordle",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "games,wordle,word games,english,german,CUI,crossplatform,python,terminal",
    "author": "",
    "author_email": "\"Silas A. Kraume\" <silas.kraume1552@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/54/40/04deee52be75320527df039aa1a720cc712e17f7d276b23d10b78874b2d9/piewordle-0.1.1.tar.gz",
    "platform": null,
    "description": "<div id=\"top\"></div>\n\n<p>\n   <a href=\"https://pepy.tech/project/piewordle/\" alt=\"Downloads\">\n      <img src=\"https://static.pepy.tech/personalized-badge/piewordle?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Downloads\" align=\"right\">\n   </a>\n   <a href=\"https://pypi.org/project/piewordle/\" alt=\"Visitors\">\n      <img src=\"https://visitor-badge.laobi.icu/badge?page_id=SilenZcience.PieWordle&right_color=orange\" align=\"right\">\n   </a>\n   <a href=\"https://github.com/SilenZcience/PieWordle/tree/main/piewordle\" alt=\"CodeSize\">\n      <img src=\"https://img.shields.io/github/languages/code-size/SilenZcience/PieWordle?color=purple\" align=\"right\">\n   </a>\n</p>\n\n[![OS-Windows]][OS-Windows]\n[![OS-Linux]][OS-Linux]\n[![OS-MacOS]][OS-MacOS]\n\n<br/>\n<div align=\"center\">\n<h2 align=\"center\">PieWordle</h2>\n   <p align=\"center\">\n      A Recreation of Wordle in Python.\n      <br/>\n      <a href=\"https://github.com/SilenZcience/PieWordle/blob/main/piewordle/wordle.py\">\n         <strong>Explore the code \u00bb</strong>\n      </a>\n      <br/>\n      <br/>\n      <a href=\"https://github.com/SilenZcience/PieWordle/issues\">Report Bug</a>\n      \u00b7\n      <a href=\"https://github.com/SilenZcience/PieWordle/issues\">Request Feature</a>\n   </p>\n</div>\n\n\n<details>\n   <summary>Table of Contents</summary>\n   <ol>\n      <li>\n         <a href=\"#about-the-project\">About The Project</a>\n         <ul>\n            <li><a href=\"#made-with\">Made With</a></li>\n         </ul>\n      </li>\n      <li>\n         <a href=\"#getting-started\">Getting Started</a>\n         <ul>\n            <li><a href=\"#prerequisites\">Prerequisites</a></li>\n            <li><a href=\"#installation\">Installation</a></li>\n         </ul>\n      </li>\n      <li><a href=\"#usage\">Usage</a>\n         <ul>\n         <li><a href=\"#examples\">Examples</a></li>\n         </ul>\n      </li>\n      <li><a href=\"#license\">License</a></li>\n      <li><a href=\"#contact\">Contact</a></li>\n   </ol>\n</details>\n\n<div id=\"about-the-project\"></div>\n\n## About The Project\n\n\n\n\n<div id=\"made-with\"></div>\n\n### Made With\n[![MadeWith-Python]](https://www.python.org/)\n[![Python][Python-Version]](https://www.python.org/)\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n<div id=\"getting-started\"></div>\n\n## Getting Started\n\n<div id=\"prerequisites\"></div>\n\n### Prerequisites\n\n- Using PieWordle demands a Python-Interpreter (>= 3.7).\n\n<div id=\"installation\"></div>\n\n### Installation\n[![Version][CurrentVersion]](https://pypi.org/project/piewordle/)\n\nSimply install the python package (via [PyPI-piewordle](https://pypi.org/project/piewordle/)):\n```console\npython -m pip install --upgrade piewordle\n```\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n<div id=\"usage\"></div>\n\n## Usage\n\n```console\npwordle [OPTION]...\n```\n\n```console\noptions:\n  -h, --help  show this help message and exit\n  --daily     guess the daily wordle.\n  -g GUESSES  define the amount of guesses the player has. default is 6.\n  -?          allow not existing words.\n  --de        use german words.\n  -w WORDS    define custom wordle options. Seperator is ';'.\n```\n\n<div id=\"examples\"></div>\n\n### Examples\n\n<details open>\n\t<summary><b>\ud83d\udcc2 Images \ud83d\udcc2</b></summary>\n   </br>\n\n   <p float=\"left\">\n      <img src=\"https://raw.githubusercontent.com/SilenZcience/PieWordle/main/img/example1.png\" width=\"49%\"/>\n      <img src=\"https://raw.githubusercontent.com/SilenZcience/PieWordle/main/img/example2.png\" width=\"49%\"/>\n   </p>\n\n</details>\n\n```console\npwordle --daily -?\n```\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n<div id=\"license\"></div>\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/SilenZcience/PieWordle/blob/main/LICENSE) file for details\n\n<div id=\"contact\"></div>\n\n## Contact\n\n> **SilenZcience** <br/>\n[![GitHub-SilenZcience][GitHub-SilenZcience]](https://github.com/SilenZcience)\n\n[OS-Windows]: https://img.shields.io/badge/os-windows-green\n[OS-Linux]: https://img.shields.io/badge/os-linux-green\n[OS-MacOS]: https://img.shields.io/badge/os-macOS-green\n\n\n[MadeWith-Python]: https://img.shields.io/badge/Made%20with-Python-brightgreen\n[Python-Version]: https://img.shields.io/badge/Python-3.7%20--%203.12%20%7C%20pypy--3.7%20--%20pypy--3.10-blue\n\n[CurrentVersion]: https://img.shields.io/pypi/v/piewordle.svg\n\n[GitHub-SilenZcience]: https://img.shields.io/badge/GitHub-SilenZcience-orange\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A Recreation of Wordle in Python.",
    "version": "0.1.1",
    "project_urls": {
        "Download": "https://github.com/SilenZcience/PieWordle/tarball/master",
        "Github": "https://github.com/SilenZcience/PieWordle",
        "Tracker": "https://github.com/SilenZcience/PieWordle/issues"
    },
    "split_keywords": [
        "games",
        "wordle",
        "word games",
        "english",
        "german",
        "cui",
        "crossplatform",
        "python",
        "terminal"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c06047cb09c14b53a9cefe74dcb2b34ae4fa41b7f2799772b0a86f96ad77385b",
                "md5": "4ab8451bc3af63cfdee21c7e0078bf06",
                "sha256": "8ab2ea384a1cfc02cc586ab3b2289a4752cb81d90f18a44ca2fbc849fba2df6e"
            },
            "downloads": -1,
            "filename": "piewordle-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4ab8451bc3af63cfdee21c7e0078bf06",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 27013,
            "upload_time": "2024-02-18T18:21:32",
            "upload_time_iso_8601": "2024-02-18T18:21:32.333993Z",
            "url": "https://files.pythonhosted.org/packages/c0/60/47cb09c14b53a9cefe74dcb2b34ae4fa41b7f2799772b0a86f96ad77385b/piewordle-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "544004deee52be75320527df039aa1a720cc712e17f7d276b23d10b78874b2d9",
                "md5": "bf59bdf5ef6b51e366b84e06ce108635",
                "sha256": "52dc3d2b47daf649dab3bec576de0e6275ca726d793bf501f337ad7b1c5c8be7"
            },
            "downloads": -1,
            "filename": "piewordle-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "bf59bdf5ef6b51e366b84e06ce108635",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 27918,
            "upload_time": "2024-02-18T18:21:34",
            "upload_time_iso_8601": "2024-02-18T18:21:34.098267Z",
            "url": "https://files.pythonhosted.org/packages/54/40/04deee52be75320527df039aa1a720cc712e17f7d276b23d10b78874b2d9/piewordle-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-18 18:21:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "SilenZcience",
    "github_project": "PieWordle",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "piewordle"
}
        
Elapsed time: 0.18883s