Metadata-Version: 2.1
Name: please-cli
Version: 0.1.1
Summary: A new tab page for your terminal
Home-page: https://github.com/NayamAmarshe/please
License: MIT
Keywords: please,cli,new tab
Author: Nayam Amarshe
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: art (>=5.6,<6.0)
Requires-Dist: autopep8 (>=1.6.0,<2.0.0)
Requires-Dist: ics (>=0.7,<0.8)
Requires-Dist: imgrender (>=0.0.4,<0.0.5)
Requires-Dist: pyfiglet (>=0.8.post1,<0.9)
Requires-Dist: python-jsonstore (>=1.3.0,<2.0.0)
Requires-Dist: requests (>=2.27.1,<3.0.0)
Requires-Dist: rich (>=12.3.0,<13.0.0)
Requires-Dist: typer (>=0.4.1,<0.5.0)
Project-URL: Documentation, https://github.com/NayamAmarshe/please
Project-URL: Repository, https://github.com/NayamAmarshe/please
Description-Content-Type: text/plain

# Please - New Tab Page for your Terminal

<p align="center"><img src="please.gif"></img></center>

# Installation

### Method 1:

1. Make sure you have Python 3 installed on your computer.
2. Open your terminal and paste the command below:

   ```bash
   pip install please-cli && echo 'please' >> ~/.`echo $0`rc

   # If you get an error about 'pip not found', just replace pip with pip3.
   ```

3. That's it! Check if `please` command works in your terminal.

### Method 2:

1. Go to the releases section.
2. Download the latest release WHL file.
3. Open terminal and paste the command below:

   ```bash
   pip install --user ~/Downloads/please_cli* && echo 'please' >> ~/.`echo $0`rc

   # If you get an error about 'pip not found', just replace pip with pip3.
   ```

   Change the path of the file if you downloaded it elsewhere.

4. That's it! Check if `please` command works in your terminal.

###### Having trouble with installation or have any ideas? Please create an issue ticket :)

# Commands

```bash
# Show time, quotes and tasks
please

# Add a task
please add "TASK NAME"

# Delete a task
please delete <TASK NUMBER>

# Mark task as done
please done <TASK NUMBER>

# Mark task as undone
pleae undone <TASK NUMBER>

# Show tasks even if all tasks are markded as done
please showtasks
```

# Local Development

1. To get started, first install poetry:

```bash
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
```

2. Clone this project
3. `cd` to the project directory and run virtual environment:

```bash
poetry shell

# OR THIS, IF 'poetry shell' doesn't work

. "$(dirname $(poetry run which python))/activate"
```

4. Install all dependencies:

```bash
poetry install
```

- `please` will be available to use as a command in the virtual environment after using `poetry install`.

5. Finally, run the python script with:

```bash
python please/please.py
```

6. To build a WHL package:

```bash
poetry build
```

- The package will be generated in **dist** folder, you can then use pip to install the WHL file.

# Uninstalling

Open your terminal and type:

```bash
pip uninstall please-cli
```

and also edit your **.zshrc** or **.bashrc** file and remove the line that says `please` at the end of the file.

