Metadata-Version: 2.4
Name: tsigna
Version: 0.2.0
Summary: Terminal tool to plot stocks, crypto, pair ratios, and technical indicators like MACD and RSI.
Project-URL: Repository, https://github.com/monsieurlinux/tsigna
Author-email: Monsieur Linux <info@mlinux.ca>
License-Expression: MIT
License-File: LICENSE
Keywords: bitcoin,cli,cryptocurrency,finance,python,stock-market,terminal,trading
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Requires-Dist: pandas<3.0.0,>=2.0.0
Requires-Dist: plotille>=5.0.0
Requires-Dist: yahooquery>=2.4.1
Description-Content-Type: text/markdown

![NVDA stock price, moving averages and volume over 1 year](https://github.com/monsieurlinux/tsigna/raw/main/img/tsigna-nvda-moving-averages-volume-1y.png "NVDA stock price, moving averages and volume over 1 year")

# Tsigna

Tsigna is a Python financial analysis tool that runs entirely in the terminal. It is most useful for medium-term trading. It fetches historical stock data from Yahoo Finance, calculates technical indicators including moving averages, MACD, and RSI, and displays them as text-based charts using the plotille library. The tool supports single ticker analysis, ratio comparisons between two tickers, and a special MMRI calculation. Users can customize the time period and split the terminal display to show multiple indicators simultaneously.

![NVDA stock price, Bollinger Bands and Stochastics over 1 year](https://github.com/monsieurlinux/tsigna/raw/main/img/tsigna-nvda-bollinger-bands-stochastics-1y.png "NVDA stock price, Bollinger Bands and Stochastics over 1 year")

## Background

Originally I was looking for a free online tool to plot the **ratio between two tickers**, but I didn't find such a tool so I started working on Tsigna. The name comes from 'T' for terminal and the plural form of signum, the latin word for signal. The 'T' also stands for technical, like in technical indicators, from which we get technical signals.

![Ratio between NVDA and WMT stock prices, moving averages and RSI indicator over 2 years](https://github.com/monsieurlinux/tsigna/raw/main/img/tsigna-nvda-wmt-moving-averages-rsi-2y.png "Ratio between NVDA and WMT stock prices, moving averages and RSI indicator over 2 years")

## Dependencies

Tsigna requires the following external libraries:

* **[pandas](https://github.com/pandas-dev/pandas)**: Used for data manipulation and analysis.
* **[plotille](https://github.com/tammoippen/plotille)**: Used for creating terminal-based plots.
* **[yahooquery](https://github.com/dpguthrie/yahooquery)**: Used for fetching financial data from Yahoo Finance.

These libraries and their sub-dependencies will be installed automatically when you install Tsigna.

## Installation

It is recommended to install Tsigna within a [virtual environment](https://docs.python.org/3/tutorial/venv.html) to avoid conflicts with system packages. Some Linux distributions enforce this. You can use `pipx` to handle the virtual environment automatically, or create one manually and use `pip`.

### Installation with `pipx`

`pipx` installs Tsigna in an isolated environment and makes it available globally.

**1. Install `pipx`:**

*   **Linux (Debian / Ubuntu / Mint):**
    
    ```bash
    sudo apt install pipx
    pipx ensurepath
    ```
*   **Linux (Other) / macOS:**
    
    ```bash
    python3 -m pip install --user pipx
    python3 -m pipx ensurepath
    ```
*   **Windows:**
    
    ```bash
    python -m pip install --user pipx
    python -m pipx ensurepath
    ```

You may need to close and restart your terminal for the PATH changes to take effect.

**2. Install Tsigna:**

```bash
pipx install tsigna
```

### Installation with `pip`

If you prefer to manage the virtual environment manually, you can create and activate it by following this [tutorial](https://docs.python.org/3/tutorial/venv.html). Then install Tsigna:

```bash
pip install tsigna
```

## Usage

### Basic Usage

```bash
tsigna [arguments] [TICKER1] [TICKER2]
```

### Command-Line Arguments

| Argument           | Short Flag | Description                                                  |
| ------------------ | ---------- | ------------------------------------------------------------ |
| `--help`           | `-h`       | Show help message                                            |
| `--atr`            | `-a`       | Display ATR indicator (Average True Range)                   |
| `--atr-only`       | `-A`       | Display **only** ATR indicator                               |
| `--bollinger`      | `-b`       | Display Bollinger Bands indicator                            |
| `--mfi`            | `-f`       | Display MFI indicator (Money Flow Index)                     |
| `--mfi-only`       | `-F`       | Display **only** MFI indicator                               |
| `--indicator-info` | `-i`       | Show indicator information                                   |
| `--macd`           | `-m`       | Display MACD indicator (Moving Average Convergence Divergence) |
| `--macd-only`      | `-M`       | Display **only** MACD indicator                              |
| `--no-cache`       | `-n`       | Bypass cache and get latest data                             |
| `--obv`            | `-o`       | Display OBV indicator (On-Balance Volume)                    |
| `--obv-only`       | `-O`       | Display **only** OBV indicator                               |
| `--rsi`            | `-r`       | Display RSI indicator (Relative Strength Index)              |
| `--rsi-only`       | `-R`       | Display **only** RSI indicator                               |
| `--stoch`          | `-s`       | Display Stochastics indicator                                |
| `--stoch-only`     | `-S`       | Display **only** Stochastics indicator                       |
| `--version`        | `-v`       | Show program's version number and exit                       |
| `--volume`         | `-w`       | Display volume                                               |
| `--volume-only`    | `-W`       | Display **only** volume                                      |
| `--years`          | `-y`       | Set years to plot, use 0 for ytd (default: 1)                |

## Not Financial Advice

I do not own any of the stocks in the examples, I chose them because they are very popular.

## License

Copyright (c) 2025 Monsieur Linux

This project is licensed under the MIT License. See the LICENSE file for details.

## Acknowledgements

Tsigna is not doing much more than getting data from [yahooquery](https://github.com/dpguthrie/yahooquery), processing it with [pandas](https://github.com/pandas-dev/pandas), and plotting it with [plotille](https://github.com/tammoippen/plotille), so thanks to the creators and contributors of these powerful libraries for making it possible.

Thanks also to the [ticker](https://github.com/achannarasappa/ticker) tool, which is very useful to track prices in real time from the terminal.
