Metadata-Version: 2.4
Name: termcam
Version: 1.0.1
Summary: A utility to create a ASCII representation of your webcam directly into your terminal!
Author-email: TecnoSamba <sannicolas2121@outlook.com>
License: Apache 2.0
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: opencv-python-headless
Description-Content-Type: text/markdown

```text
  _____                    ____                
 |_   _|__ _ __ _ __ ___  / ___|__ _ _ __ ___ 
   | |/ _ \ '__| '_ ` _ \| |   / _` | '_ ` _ \ 
   | |  __/ |  | | | | | | |__| (_| | | | | | |
   |_|\___|_|  |_| |_| |_|\____\__,_|_| |_| |_|
```

# 👋 Welcome to the **TermCam** repository!

**TermCam** is a utility to create a ASCII representation of your webcam directly into your terminal:

![TermCam showcase video](assets/showcase.gif)

<details>

<summary>📚 Table of contents</summary>

- [Usage](#usage)
  - [Parameters](#parameters)
- [Installation](#installation)
  - [Using `pipx` (recommended)](#using-pipx-recommended)
  - [Using `pip`](#using-pip)

</details>

## Usage

To activate **TermCam** simply run the `termcam` command with the desired running parameters:

```bash
termcam [options]
```

> [!WARNING]
> To successfully run **TermCam** your terminal **must** support the `truecolor` representation interface. To check so, run the following command:
> ```bash
> echo $COLORTERM
> ```
> If the result is `termcolor` or `24bit` there should not be any problem. However, if the result is different than the two mentioned before, **TermCam** is likely unable to run correctly in your terminal.

### Parameters

**TermCam** accepts a list of the following running parameters that modify its behaviour:

- `-c/--character <string>`: sets the sets the character that will be used in the ASCII representation. By default: `@`.
- `-w/--width <int>`: sets the width size of the visualization frame. By default: 80.
- `-t/--height <int>`: sets the height size of the visualization frame. By default: 30.
- `-s/--source <int>`: sets the webcam to use in the visualization based on its source index. By default: 0.
- `-f/--flip`: flips the view horizontally in order to create a mirror effect.
- `-h/--help`: displays the help view.

## Installation

### Using `pipx` (recommended)

``` bash
pipx install termcam
```

### Using `pip`

``` bash
pip install termcam
```

Made with ❤️ by [@TecnoSamba](https://github.com/tecnosamba)