Metadata-Version: 2.4
Name: pyllo_greeting
Version: 0.0.1
Summary: CLI application for testing Python distribution methods
Author: João Antônio
License-Expression: MIT
Project-URL: Homepage, https://github.com/joao-antonio-la/pyllo_greeting
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# pyllo_greeting

Simple CLI application created for studying Python apps distribution methods.

## Installation

> ⚠️ You must have python installed to use this application.

1. Clone the repository:

``` sh
git clone https://github.com/joao-antonio-la/pyllo_greeting.git
```

- After cloning the repo, you are ready to use the application.

## Usage

With the application locally into your machine, you can use it by following the steps bellow:

1. Enter the project folder:

``` sh
cd pyllo_greeting
```

2. Create the virtual environment:

``` sh
python -m venv .venv  # Windows
python3 -m venv .venv # MacOS and Linux
```

3. Activate the venv:

``` sh
.venv\Scripts\activate    # Windows
source .venv/bin/activate # MacOS and Linux
```

4. Install the project locally:

``` sh
pip install .
```

5. Use the CLI:

``` sh
pyllo
# Output: Hello there
```

### Options

#### Name and Tones

- It is possible to pass a name/word to be greeted by the app:

``` sh
pyllo John
# Hello there, John
```

``` sh
pyllo everyone
# Hello there, everyone
```

- Secondly, there is also the possibity of informing a tone. The default tone is "normal":

1. `Normal/Default`:

``` sh
pyllo Alice
# Hello there, Alice
```

2. `Quick`:

``` sh
pyllo Theresa --quick
# Hi, Theresa

pyllo Matthew -q
# Hi, Matthew
```

3. `Fancy`:

``` sh
pyllo Leticia --fancy
# Greetings. It is truly a pleasure to acknowledge your existence, Leticia

pyllo Beatrice -f
# Greetings. It is truly a pleasure to acknowledge your existence, Beatrice
```

#### Meta Options

There are currently two `meta` options:

1. `App Version (--version | -v)`:

``` sh
pyllo -v
# 0.1.0
```

2. `App's Credits (--credits | -c)`:

``` sh
pyllo -c
# Project created by:
#         João Antônio

# Author's GitHub:
#         https://github.com/joao-antonio-la

# Project's Repository:
#         https://github.com/joao-antonio-la/pyllo
```
