Install & Compatibility
Where this runs
tested against v0.5.4 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.606s · 135.7MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 9.0s · import 0.586s · 131MB
136MB installed
● package 136MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
Agent
✓ from simile import Agent
✗ from simile.agent import Agent
Top-level import changed in 0.4.0; submodule import no longer works.
Simulation
✓ from simile import Simulation
✗ from simile.simulation import Simulation
Simulation is now exported at package level.
AgentConfig
✓ from simile import AgentConfig
Used to configure agent personality and knowledge base.
Initialize a Simile agent and run a simple simulation.
from simile import Agent, Simulation
# Create an agent
agent = Agent(
name="CustomerBot",
api_key=os.environ.get("SIMILE_API_KEY", ""),
model="gpt-4"
)
# Create a simulation
sim = Simulation(agents=[agent])
# Run a conversation
response = sim.run("Hello, how are you?")
print(response)
Errors
Common errors & fixes
ImportError: cannot import name 'Agent' from 'simile.agent'
Import path changed in v0.5.0.
fixUse `from simile import Agent`.
AuthError: No API key provided
Missing or empty SIMILE_API_KEY environment variable.
fixSet the environment variable `SIMILE_API_KEY` or pass `api_key` to Agent constructor.
TypeError: Agent.__init__() got an unexpected keyword argument 'model'
`model` parameter removed in 0.6.0 (future).
fixUse `AgentConfig(model='gpt-4')` and pass as `config` to Agent.
Upgrade
Version history
0.5.4latest on PyPI · released Jan 22, 2026
Audit
Dependencies
httpxrequiredHTTP client for API calls
pydanticrequiredData validation