Skip to main content

A small single-session chat client for OpenAI-compatible Responses API endpoints.

Project description

codex-chat-bot

A small Python chat project with:

  • a Python programming interface
  • a command-line interface
  • single-session memory
  • configurable API key, base URL, model, and system rules

The project uses OpenAI SDK-compatible Responses API endpoints.

Installation

python -m pip install codex-chat-bot

Environment Variables

Only CODEX_CHAT_* environment variables are read:

export CODEX_CHAT_API_KEY="your API key"
export CODEX_CHAT_BASE_URL="https://api.openai.com/v1"
export CODEX_CHAT_MODEL="gpt-5.5"                       # optional

JSON Config File

You can also load api_key, base_url, model, and system_rules from a UTF-8 JSON file:

{
    "api_key": "your API key",
    "base_url": "https://api.openai.com/v1",
    "model": "gpt-5.5",
    "system_rules": [
        "You are a concise programming assistant.",
        "Answer in English."
    ]
}

Use --config or --config-file to choose the file:

codex-chat --config ./config.json "Hello"

Values from the config file are used before environment variables and command line options, so CODEX_CHAT_* variables and explicit flags can still override the file for one run.

Command-Line Usage

Run a single chat turn:

codex-chat "Write a Python hello world example."

Start interactive chat:

codex-chat

If codex-chat is not on your PATH, run the module directly:

python -m codex_chat_bot.cli
python -m codex_chat_bot.cli "Hello"

Interactive commands:

  • /name NAME changes the name used for your next messages. The default name is user.
  • /reset clears the current session memory.
  • /import PATH loads chat history from a JSON file.
  • /export PATH saves chat history to a JSON file.
  • /exit or /quit exits the chat.

Common options:

codex-chat --api-key "your API key" --base-url "https://api.openai.com/v1" "Hello"
codex-chat --config ./config.json "Hello"
codex-chat --model gpt-5.5 --system "You are a concise programming assistant."
codex-chat --system-rule "Answer in English." --system-rule "Keep answers short." "Explain pytest."
codex-chat --system-rules-file ./rules.txt "Review this idea."
codex-chat --bind-history ./history.json "Continue our chat."
codex-chat --base-url "https://api.openai.com/v1" "Explain pytest."

If CODEX_CHAT_API_KEY or CODEX_CHAT_BASE_URL is not set and the value was not passed on the command line, interactive CLI startup prompts for the missing value.

--bind-history loads the JSON file if it already exists, creates an empty history file if it does not, and writes every new message to that file as the chat changes. If the file exists but is not valid chat history JSON, the CLI prints a warning and recreates it as an empty history file.

Python API

from codex_chat_bot import ChatConfig, ChatSession

session = ChatSession(ChatConfig.from_env())

print(session.ask("Remember that my project is named codex-chat-bot."))
print(session.ask("What is my project called?"))
print(session.ask("This is Alice speaking.", username="alice"))

session.bind_history("history.json")
session.ask("This message is saved automatically.")

You can also pass configuration explicitly:

from codex_chat_bot import ChatConfig, ChatSession

config = ChatConfig(
    api_key="your API key",
    base_url="https://api.openai.com/v1",
    model="gpt-5.5",
    system_rules=(
        "You are a patient Python programming assistant.",
        "Answer in English.",
        "Keep code examples runnable.",
    ),
)

session = ChatSession(config)
answer = session.ask("Write a function that reads a JSON file.")
print(answer)

system_rules are added to the session's initial system message and stay active until the session is reset.

Pass username= to ask() or send() to distinguish different people in one session. User messages are sent to the model with the speaker name included, and chat history stores each message's username.

Chat history JSON uses a top-level messages array:

{
    "messages": [
        { "role": "system", "content": "You are a helpful assistant.", "username": "system" },
        { "role": "user", "content": "Hello", "username": "alice" },
        { "role": "assistant", "content": "Hi!", "username": "assistant" }
    ]
}

Tests

python -m pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codex_chat_bot-0.1.3.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codex_chat_bot-0.1.3-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file codex_chat_bot-0.1.3.tar.gz.

File metadata

  • Download URL: codex_chat_bot-0.1.3.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.11.15 Windows/10

File hashes

Hashes for codex_chat_bot-0.1.3.tar.gz
Algorithm Hash digest
SHA256 65d0c529bc3d73f74b08df51409b77d86594dafcb35a85669ad7d95423536faf
MD5 4facec0e787509904be596bb7ac93db0
BLAKE2b-256 cb1f474713608d53fb251fc6252e6e78e457ba476b745916be4047e0dc88fe44

See more details on using hashes here.

File details

Details for the file codex_chat_bot-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: codex_chat_bot-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 10.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.11.15 Windows/10

File hashes

Hashes for codex_chat_bot-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 11213617ddde201adfbf0141d90757fea3572a7ce042ec8f81a432700d0282b3
MD5 61732dac6ff6f71dbeb79bad9ee789e0
BLAKE2b-256 c7699d58c94ea4bbce523ff805b968daa0e0915b9143a2ebd0b6f5d043e3ad83

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page