zjz-cli 0.0.3

自记账的工具箱

zjz_cli

Cli tool for zjz

Requirements

• Python 3.10 or higher – Download Python

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:

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:

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

• Windows (Command Prompt):

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

• Windows (PowerShell):

.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:

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:

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.