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

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:

  • /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 --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?"))

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.

Chat history JSON uses a top-level messages array:

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

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.1.tar.gz (9.8 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.1-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: codex_chat_bot-0.1.1.tar.gz
  • Upload date:
  • Size: 9.8 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.1.tar.gz
Algorithm Hash digest
SHA256 31c7073b0c3b540289f74f5fa7c9727226156bef0fae77dacc0b14b359be6e59
MD5 e4e37fd6f3022f650105e789a8cd741f
BLAKE2b-256 d117aa1f754280c1160cb57305b1f0427b4c28c90550dbabd6fc62cad63c9d18

See more details on using hashes here.

File details

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

File metadata

  • Download URL: codex_chat_bot-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.3 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6c7f22efc0772911b778d925f59ff90d04805fa39001425c20a67c379953b874
MD5 4314edff8583e7ae700bc85d5a4d6b2c
BLAKE2b-256 4adba572ea66a985b4552bb9eb6d61d7a2016af341bf6e67fd5230696b3f914a

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