geneplus-tools-test 0.1.1

GenePlus Python Client - A simple HTTP client for GenePlus API

GenePlus Tools Test

GenePlus Python Client - A simple HTTP client for GenePlus API.

Installation

pip install geneplus-tools-test

Quick Start

from geneplus_tools_test import GenePlusClient

# Create client (token will be loaded from config or environment variable)
client = GenePlusClient()

# Test connectivity
result = client.ping()
print(result)  # 'pong'

# Get user info
info = client.get_info("张三", "13512341234")
print(info)  # '张三 - 13512341234，喜欢探索新事物'

Configuration

The client can be configured in three ways (in order of priority):

1. Direct Token

client = GenePlusClient(token="your-token-here")

2. Environment Variable

export GENEPLUS_TOKEN="your-token-here"

client = GenePlusClient()  # Will use GENEPLUS_TOKEN

3. Config File

Create ~/.config/geneplus/token.json:

{
  "gp-tools-token": "your-token-here"
}

client = GenePlusClient()  # Will read from config file

CLI Usage

After installation, you can use the gp-tool command:

Test connectivity

gp-tool ping

Get user information

gp-tool get-info --name "张三" --phone "13512341234"

Help

gp-tool --help
gp-tool get-info --help

API Reference

GenePlusClient

__init__(token=None, base_url=None)

Initialize the client.

• token: Optional API token
• base_url: Optional base URL (default: http://jdh.test.geneplus.org.cn)

ping() -> str

Test network connectivity to the server.

Returns response text from the server.

Raises GenePlusConnectionError if connection fails.

get_info(name: str, phone: str) -> str

Get user information from the server.

• name: User name
• phone: User phone number (11 digits, starts with 1)

Returns user information string.

Raises:

• ValueError: If phone number format is invalid
• GenePlusAuthError: If token is invalid
• GenePlusAPIError: If API returns other errors
• GenePlusConnectionError: If network connection fails

Exceptions

• GenePlusError: Base exception
• GenePlusConnectionError: Network connection error
• GenePlusAuthError: Authentication error (invalid token)
• GenePlusAPIError: API error
• GenePlusConfigError: Configuration error (missing token)

Development

Setup

git clone https://github.com/geneplus/geneplus-tools-test.git
cd geneplus-tools-test
pip install -e ".[dev]"

Build

python -m build

Publish to PyPI

twine upload dist/*

License

MIT