Metadata-Version: 2.4
Name: zjz_cli
Version: 0.0.4
Summary: 自记账的工具箱
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: annotated-doc>=0.0.4
Requires-Dist: anyio>=4.0.0
Requires-Dist: certifi>=2024.2.25
Requires-Dist: click>=8.3.1
Requires-Dist: h11>=0.16.0
Requires-Dist: httpcore>=1.0.9
Requires-Dist: httpx>=0.28.1
Requires-Dist: idna>=3.0
Requires-Dist: markdown-it-py>=4.0.0
Requires-Dist: mdurl>=0.1.2
Requires-Dist: packaging>=24.0
Requires-Dist: Pygments>=2.10.0
Requires-Dist: rich>=14.3.3
Requires-Dist: shellingham>=1.5.4
Requires-Dist: typer>=0.24.1
Requires-Dist: typing_extensions>=4.12.0

# zjz_cli

Cli tool for zjz

## Requirements

- Python 3.10 or higher – [Download Python](https://www.python.org/downloads/)

## Installation

It is **strongly recommended** to install this tool inside a Python virtual environment (`venv`) to avoid dependency conflicts with other Python projects on your system.

### Step 1: Create a virtual environment

Open your terminal and choose a location for the environment. A common practice is to place it in your home directory as a hidden folder (e.g., `~/.my-cli-tool-env`). Run:

```shell
python3.10 -m venv ~/.my-cli-tool-env
```

> **Note**: Use `python3.10` or `python3.11` etc., depending on your installed Python version. Ensure the version is **3.10+**.

### Step 2: Activate the virtual environment

- Linux / macOS:

```shell
source ~/.my-cli-tool-env/bin/activate
```

- Windows (Command Prompt):

```bash
.my-cli-tool-env\Scripts\activate.bat
```

- Windows (PowerShell):

```bash
.my-cli-tool-env\Scripts\Activate.ps1
```

You will see (`.my-cli-tool-env`) appear at the beginning of your command prompt, indicating the virtual environment is active.

### Step 3: Install the tool

With the virtual environment activated, install the package from PyPI:

```shell
pip install --upgrade zjz-cli
```

That's it! The CLI command `zjz_cli` is now available inside this virtual environment.

### Usage

Once the virtual environment is activated, you can run the tool:

```shell
zjz_cli --help
```

## Why a virtual environment?

Using `venv` prevents version clashes between Python packages required by this tool and other Python applications on your system. It also keeps your global Python installation clean. For more background, see [Python Virtual Environments: A Primer](https://realpython.com/python-virtual-environments-a-primer/).
