diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 084d5ea..e5418fd 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -7,7 +7,7 @@ on: workflow_dispatch: env: - PYPI_PROJECT_NAME: agent-ref + PYPI_PROJECT_NAME: agent-checkpoint-cas permissions: contents: read @@ -90,7 +90,7 @@ jobs: runs-on: ubuntu-latest environment: name: pypi - url: https://pypi.org/project/agent-ref/ + url: https://pypi.org/project/agent-checkpoint-cas/ permissions: id-token: write diff --git a/README.md b/README.md index 45da78e..14e7309 100644 --- a/README.md +++ b/README.md @@ -41,18 +41,40 @@ RSS values across machines. ## Install +The PyPI distribution is `agent-checkpoint-cas`; the Python import package stays +`agentref`. + +With pip: + ```bash -pip install agentref +pip install agent-checkpoint-cas ``` Optional framework integrations are split by extra: ```bash -pip install "agentref[langgraph]" -pip install "agentref[llamaindex]" -pip install "agentref[autogen]" -pip install "agentref[postgres]" -pip install "agentref[all]" +pip install "agent-checkpoint-cas[langgraph]" +pip install "agent-checkpoint-cas[llamaindex]" +pip install "agent-checkpoint-cas[autogen]" +pip install "agent-checkpoint-cas[postgres]" +pip install "agent-checkpoint-cas[all]" +``` + +With uv in a project: + +```bash +uv add agent-checkpoint-cas +uv add "agent-checkpoint-cas[langgraph]" +uv add "agent-checkpoint-cas[llamaindex]" +uv add "agent-checkpoint-cas[autogen]" +uv add "agent-checkpoint-cas[postgres]" +uv add "agent-checkpoint-cas[all]" +``` + +With uv in the current environment: + +```bash +uv pip install agent-checkpoint-cas ``` ## Usage diff --git a/pyproject.toml b/pyproject.toml index 59c731e..02c9ac7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["setuptools>=68"] build-backend = "setuptools.build_meta" [project] -name = "agentref" +name = "agent-checkpoint-cas" version = "0.1.0" description = "Type-guided externalized state for LLM agent frameworks." readme = "README.md"