Current section
Files
Jump to
Current section
Files
mix.exs
defmodule CodexSdk.MixProject do
use Mix.Project
@version "0.4.2"
@source_url "https://github.com/nshkrdotcom/codex_sdk"
def project do
[
app: :codex_sdk,
version: @version,
elixir: "~> 1.14",
start_permanent: Mix.env() == :prod,
deps: deps(),
docs: docs(),
description: description(),
package: package(),
name: "Codex SDK",
source_url: @source_url,
homepage_url: @source_url,
test_coverage: [tool: ExCoveralls],
preferred_cli_env: [
coveralls: :test,
"coveralls.detail": :test,
"coveralls.post": :test,
"coveralls.html": :test
],
dialyzer: [
plt_add_apps: [:mix],
plt_file: {:no_warn, "priv/plts/dialyzer.plt"},
flags: [:error_handling, :underspecs]
]
]
end
def application do
[
mod: {Codex.Application, []},
extra_applications: [:logger, :crypto, :erlexec]
]
end
defp deps do
[
# Core dependencies
{:jason, "~> 1.4"},
{:typed_struct, "~> 0.3.0"},
{:telemetry, "~> 1.3"},
{:erlexec, "~> 2.0"},
{:opentelemetry, "~> 1.3"},
{:opentelemetry_exporter, "~> 1.6"},
# Testing
{:supertester, "~> 0.2.1", only: :test},
{:mox, "~> 1.0", only: :test},
{:stream_data, "~> 1.0", only: :test},
# Development and documentation
{:ex_doc, "~> 0.38.2", only: :dev, runtime: false},
{:credo, "~> 1.7", only: [:dev, :test], runtime: false},
{:dialyxir, "~> 1.4", only: [:dev], runtime: false},
{:excoveralls, "~> 0.18", only: :test}
]
end
defp description do
"""
Idiomatic Elixir SDK for OpenAI's Codex agent. Provides a complete, production-ready
interface with streaming support, comprehensive event handling, and robust testing utilities.
"""
end
defp docs do
design_docs =
"docs/design/*.md"
|> Path.wildcard()
|> Enum.sort()
phase_docs =
"docs/20251018/**/*.md"
|> Path.wildcard()
|> Enum.sort()
extras =
[
"README.md",
"LICENSE",
"CHANGELOG.md",
"docs/01.md",
"docs/02-architecture.md",
"docs/03-implementation-plan.md",
"docs/04-testing-strategy.md",
"docs/05-api-reference.md",
"docs/09-app-server-transport.md",
"docs/06-examples.md",
"docs/07-python-parity-plan.md",
"docs/08-tdd-implementation-guide.md",
"docs/fixtures.md",
"docs/observability-runbook.md",
"docs/python-parity-checklist.md"
]
|> Enum.concat(design_docs)
|> Enum.concat(phase_docs)
[
main: "readme",
name: "Codex SDK",
source_ref: "v#{@version}",
source_url: @source_url,
homepage_url: @source_url,
assets: %{"assets" => "assets"},
logo: "assets/codex_sdk.svg",
extras: extras,
groups_for_extras: [
Introduction: ["README.md", "docs/01.md"],
"Getting Started": [
"docs/02-architecture.md",
"docs/03-implementation-plan.md",
"docs/04-testing-strategy.md",
"docs/05-api-reference.md",
"docs/09-app-server-transport.md"
],
Reference: [
"docs/06-examples.md",
"docs/07-python-parity-plan.md",
"docs/08-tdd-implementation-guide.md",
"docs/fixtures.md",
"docs/observability-runbook.md",
"docs/python-parity-checklist.md",
"LICENSE"
],
Design: design_docs,
"Implementation Phases": phase_docs,
Changelog: ["CHANGELOG.md"]
],
groups_for_modules: [
"Public API": [
Codex,
Codex.Thread,
Codex.Thread.Options,
Codex.Options,
Codex.Turn.Result
],
Execution: [
Codex.Exec,
Codex.Events,
Codex.Items,
Codex.Telemetry
],
Files: [
Codex.Files,
Codex.Files.Registry,
Codex.OutputSchemaFile
],
Approvals: [
Codex.Approvals,
Codex.Approvals.Registry,
Codex.Approvals.Hook,
Codex.Approvals.StaticPolicy,
Codex.ApprovalError
],
Tooling: [
Codex.Tool,
Codex.Tools,
Codex.Tools.Registry,
Codex.MCP.Client
],
Errors: [
Codex.Error,
Codex.TransportError
],
Tasks: [
Mix.Tasks.Codex.Parity,
Mix.Tasks.Codex.Verify
]
]
]
end
defp package do
[
name: "codex_sdk",
description: description(),
files: ~w(lib config priv mix.exs README.md CHANGELOG.md docs LICENSE assets examples),
licenses: ["MIT"],
links: %{
"GitHub" => @source_url,
"OpenAI Codex" => "https://github.com/openai/codex"
},
maintainers: ["nshkrdotcom"],
exclude_patterns: [
"priv/plts",
".DS_Store"
]
]
end
end