Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,22 @@ OpenAI, and it is not an OpenAI product or a first-party Codex component. It
ships no OpenAI logo or other visual branding. It is named for the Codex
sessions it reads.

## Install

```bash
python -m pip install codex-preserve
```

Python 3.9 or newer. No runtime dependencies. Confirm the CLI surface with:

```bash
codex-preserve --help
```

Public project pages: [PyPI](https://pypi.org/project/codex-preserve/) ·
[Releases](https://github.com/davidqyc/codex-preserve/releases) ·
[Issues](https://github.com/davidqyc/codex-preserve/issues)

## What it does

- **Exports** one already-persisted local Codex rollout into a per-session
Expand Down Expand Up @@ -99,19 +115,12 @@ human-readable export, in the stable output basename, and in the output
directory / bucket names. The raw remote URL is discarded and never
exported, with or without the flag.

## Install

```bash
pip install .
```

Python 3.9 or newer. No runtime dependencies.

## Try it in one command

You do not need a Codex session to see what this tool does. Three synthetic
example packages ship with the repository and exercise the entire
verification contract:
example packages and the runner script below live in the repository
checkout, not in the installed wheel; from a clone of the repository they
exercise the entire verification contract:

```bash
./examples/run_examples.sh
Expand Down
8 changes: 7 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "codex-preserve"
version = "0.1.0"
version = "0.1.1"
description = "Export OpenAI Codex sessions to durable, human-readable packages and verify them against a manifest."
readme = "README.md"
requires-python = ">=3.9"
Expand Down Expand Up @@ -38,6 +38,12 @@ classifiers = [
[project.scripts]
codex-preserve = "codex_preserve.cli:main"

[project.urls]
Homepage = "https://github.com/davidqyc/codex-preserve"
Repository = "https://github.com/davidqyc/codex-preserve"
Issues = "https://github.com/davidqyc/codex-preserve/issues"
"Release notes" = "https://github.com/davidqyc/codex-preserve/releases"

[tool.setuptools]
package-dir = {"" = "src"}

Expand Down
Loading