Metadata-Version: 2.1
Name: wordlecli
Version: 0.2.3
Summary: wordle, but in the command line
License: MIT
Author: ZenithDS
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: DateTime (>=4.4,<5.0)
Requires-Dist: pyperclip (>=1.8.2,<2.0.0)
Requires-Dist: rich (>=11.2.0,<12.0.0)
Requires-Dist: typer (>=0.4.0,<0.5.0)
Description-Content-Type: text/markdown

<h2 align="center"> ━━━━━━  ❖  ━━━━━━ </h2>

<!-- BADGES -->
<div align="center">
   <p></p>
   
   <img src="https://img.shields.io/github/stars/dotzenith/wordle-cli?color=F8BD96&labelColor=302D41&style=for-the-badge">   

   <img src="https://img.shields.io/github/forks/dotzenith/wordle-cli?color=DDB6F2&labelColor=302D41&style=for-the-badge">   

   <img src="https://img.shields.io/github/repo-size/dotzenith/wordle-cli?color=ABE9B3&labelColor=302D41&style=for-the-badge">
   
   <img src="https://img.shields.io/github/commit-activity/y/dotzenith/wordle-cli?color=96CDFB&labelColor=302D41&style=for-the-badge&label=COMMITS"/>
   <br>
</div>

<p/>

---

### ❖ Information 

  wordle-cli is, as the name suggests, wordle in the command-line. There are no fancy gui/tui elements, just a simple and minimalistic way to play wordle :)

  <img src="https://github.com/dotzenith/dotzenith/blob/main/assets/wordle-cli/wordle.gif" alt="wordle preview">

---

### ❖ Installation

> Install from pip
```sh
$ pip3 install wordlecli
```

> Install from source
- First, install [poetry](https://python-poetry.org/)
```sh
$ git clone https://github.com/ZenithDS/wordle-cli.git
$ cd wordle-cli
$ poetry build
$ pip3 install ./dist/wordlecli-0.2.3.tar.gz
```

### ❖ Usage 

Playing wordle in the command-line is as simple as running the following command:

```sh
$ wordle
```

But if your addiction to wordle needs more, you can also play an older wordle by specifying it's number

```sh
$ wordle 240
```

The on-screen keyboard can be turned off using the `--hard` option

```sh
$ wordle --hard
```

---

### ❖ What's New? 
0.2.3 - Added type hints

---

<div align="center">

   <img src="https://img.shields.io/static/v1.svg?label=License&message=MIT&color=F5E0DC&labelColor=302D41&style=for-the-badge">

</div>


