Skip to content

Commit 8558481

Browse files
authored
docs: standardize package README.md structure (#8064)
Aligns the repository's package READMEs around a shared documentation shape so users see consistent install, positioning, docs, release, and contribution guidance across LangGraph packages.
1 parent 4cf120d commit 8558481

11 files changed

Lines changed: 301 additions & 140 deletions

File tree

β€Žexamples/README.mdβ€Ž

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
# LangGraph examples
22

3-
This directory is retained purely for archival purposes and is no longer updated. The examples previously found here have been moved to the newly [consolidated LangChain documentation](https://docs.langchain.com/oss/python/langgraph/overview). Please refer to the LangChain docs for the most up-to-date examples and usage guidelines for LangGraph.
3+
This directory is retained purely for archival purposes and is no longer updated.
4+
5+
## πŸ€” What is this?
6+
7+
The examples previously found here have been moved to the consolidated LangChain documentation. This directory remains available for historical reference, but new examples and usage guidance are published in the docs.
8+
9+
## πŸ“– Documentation
10+
11+
For up-to-date LangGraph examples, tutorials, and guides, see the [LangGraph Docs](https://docs.langchain.com/oss/python/langgraph/overview). Get started with the [LangGraph Quickstart](https://docs.langchain.com/oss/python/langgraph/quickstart).

β€Žlibs/checkpoint-conformance/README.mdβ€Ž

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,27 @@
1-
# langgraph-checkpoint-conformance
1+
# LangGraph Checkpoint Conformance
22

3-
Conformance test suite for [LangGraph](https://github.com/langchain-ai/langgraph) checkpointer implementations.
3+
[![PyPI - Version](https://img.shields.io/pypi/v/langgraph-checkpoint-conformance?label=%20)](https://pypi.org/project/langgraph-checkpoint-conformance/#history)
4+
[![PyPI - License](https://img.shields.io/pypi/l/langgraph-checkpoint-conformance)](https://opensource.org/licenses/MIT)
5+
[![PyPI - Downloads](https://img.shields.io/pepy/dt/langgraph-checkpoint-conformance)](https://pypistats.org/packages/langgraph-checkpoint-conformance)
6+
[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchain_oss.svg?style=social&label=Follow%20%40LangChain)](https://x.com/langchain_oss)
47

5-
Validates that a `BaseCheckpointSaver` subclass correctly implements the checkpoint storage contract β€” blob round-trips, metadata preservation, namespace isolation, incremental channel updates, and more.
8+
To help you ship LangGraph apps to production faster, check out [LangSmith](https://www.langchain.com/langsmith).
9+
[LangSmith](https://www.langchain.com/langsmith) is a unified developer platform for building, testing, and monitoring LLM applications.
610

7-
## Installation
11+
## Quick Install
812

913
```bash
10-
pip install langgraph-checkpoint-conformance
14+
uv add langgraph-checkpoint-conformance
1115
```
1216

17+
## πŸ€” What is this?
18+
19+
This library provides a conformance test suite for [LangGraph](https://github.com/langchain-ai/langgraph) checkpointer implementations. It validates that a `BaseCheckpointSaver` subclass correctly implements the checkpoint storage contract β€” blob round-trips, metadata preservation, namespace isolation, incremental channel updates, and more.
20+
21+
## πŸ“– Documentation
22+
23+
For full documentation, see the [API reference](https://reference.langchain.com/python/langgraph/). For conceptual guides on persistence and memory, see the [LangGraph Docs](https://docs.langchain.com/oss/python/langgraph/overview).
24+
1325
## Quick start
1426

1527
Register your checkpointer with `@checkpointer_test` and run `validate()`:
@@ -110,3 +122,13 @@ async def pg_checkpointer():
110122
async with PostgresSaver.from_conn_string(CONN_STRING) as saver:
111123
yield saver
112124
```
125+
126+
## πŸ“• Releases & Versioning
127+
128+
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
129+
130+
## πŸ’ Contributing
131+
132+
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
133+
134+
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).

β€Žlibs/checkpoint-postgres/README.mdβ€Ž

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,28 @@
11
# LangGraph Checkpoint Postgres
22

3-
Implementation of LangGraph CheckpointSaver that uses Postgres.
3+
[![PyPI - Version](https://img.shields.io/pypi/v/langgraph-checkpoint-postgres?label=%20)](https://pypi.org/project/langgraph-checkpoint-postgres/#history)
4+
[![PyPI - License](https://img.shields.io/pypi/l/langgraph-checkpoint-postgres)](https://opensource.org/licenses/MIT)
5+
[![PyPI - Downloads](https://img.shields.io/pepy/dt/langgraph-checkpoint-postgres)](https://pypistats.org/packages/langgraph-checkpoint-postgres)
6+
[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchain_oss.svg?style=social&label=Follow%20%40LangChain)](https://x.com/langchain_oss)
47

5-
## Dependencies
8+
To help you ship LangGraph apps to production faster, check out [LangSmith](https://www.langchain.com/langsmith).
9+
[LangSmith](https://www.langchain.com/langsmith) is a unified developer platform for building, testing, and monitoring LLM applications.
610

7-
By default `langgraph-checkpoint-postgres` installs `psycopg` (Psycopg 3) without any extras. However, you can choose a specific installation that best suits your needs [here](https://www.psycopg.org/psycopg3/docs/basic/install.html) (for example, `psycopg[binary]`).
11+
## Quick Install
12+
13+
```bash
14+
uv add langgraph-checkpoint-postgres
15+
```
16+
17+
## πŸ€” What is this?
18+
19+
This library provides a Postgres implementation of LangGraph's checkpoint saver. Use it when you want LangGraph state persistence backed by Postgres for durable, long-running workflows and agents.
20+
21+
By default, `langgraph-checkpoint-postgres` installs `psycopg` (Psycopg 3) without any extras. You can choose a specific installation that best suits your needs in the [Psycopg installation docs](https://www.psycopg.org/psycopg3/docs/basic/install.html), for example `psycopg[binary]`.
22+
23+
## πŸ“– Documentation
24+
25+
For full documentation, see the [API reference](https://reference.langchain.com/python/langgraph.checkpoint.postgres). For conceptual guides on persistence and memory, see the [LangGraph Docs](https://docs.langchain.com/oss/python/langgraph/overview).
826

927
## Security
1028

@@ -20,10 +38,12 @@ By default `langgraph-checkpoint-postgres` installs `psycopg` (Psycopg 3) withou
2038
> When manually creating Postgres connections and passing them to `PostgresSaver` or `AsyncPostgresSaver`, make sure to include `autocommit=True` and `row_factory=dict_row` (`from psycopg.rows import dict_row`). See a full example in this [how-to guide](https://langchain-ai.github.io/langgraph/how-tos/persistence_postgres/).
2139
>
2240
> **Why these parameters are required:**
41+
>
2342
> - `autocommit=True`: Required for the `.setup()` method to properly commit the checkpoint tables to the database. Without this, table creation may not be persisted.
2443
> - `row_factory=dict_row`: Required because the PostgresSaver implementation accesses database rows using dictionary-style syntax (e.g., `row["column_name"]`). The default `tuple_row` factory returns tuples that only support index-based access (e.g., `row[0]`), which will cause `TypeError` exceptions when the checkpointer tries to access columns by name.
2544
>
2645
> **Example of incorrect usage:**
46+
>
2747
> ```python
2848
> # ❌ This will fail with TypeError during checkpointer operations
2949
> with psycopg.connect(DB_URI) as conn: # Missing autocommit=True and row_factory=dict_row
@@ -118,3 +138,13 @@ async with AsyncPostgresSaver.from_conn_string(DB_URI) as checkpointer:
118138
# list checkpoints
119139
[c async for c in checkpointer.alist(read_config)]
120140
```
141+
142+
## πŸ“• Releases & Versioning
143+
144+
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
145+
146+
## πŸ’ Contributing
147+
148+
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
149+
150+
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).

β€Žlibs/checkpoint-sqlite/README.mdβ€Ž

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
11
# LangGraph SQLite Checkpoint
22

3-
Implementation of LangGraph CheckpointSaver that uses SQLite DB (both sync and async, via `aiosqlite`)
3+
[![PyPI - Version](https://img.shields.io/pypi/v/langgraph-checkpoint-sqlite?label=%20)](https://pypi.org/project/langgraph-checkpoint-sqlite/#history)
4+
[![PyPI - License](https://img.shields.io/pypi/l/langgraph-checkpoint-sqlite)](https://opensource.org/licenses/MIT)
5+
[![PyPI - Downloads](https://img.shields.io/pepy/dt/langgraph-checkpoint-sqlite)](https://pypistats.org/packages/langgraph-checkpoint-sqlite)
6+
[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchain_oss.svg?style=social&label=Follow%20%40LangChain)](https://x.com/langchain_oss)
7+
8+
To help you ship LangGraph apps to production faster, check out [LangSmith](https://www.langchain.com/langsmith).
9+
[LangSmith](https://www.langchain.com/langsmith) is a unified developer platform for building, testing, and monitoring LLM applications.
10+
11+
## Quick Install
12+
13+
```bash
14+
uv add langgraph-checkpoint-sqlite
15+
```
16+
17+
## πŸ€” What is this?
18+
19+
This library provides a SQLite implementation of LangGraph's checkpoint saver, with both sync and async support via `aiosqlite`. Use it when you want LangGraph state persistence backed by SQLite for local development, testing, or lightweight deployments.
20+
21+
## πŸ“– Documentation
22+
23+
For full documentation, see the [API reference](https://reference.langchain.com/python/langgraph.checkpoint.sqlite). For conceptual guides on persistence and memory, see the [LangGraph Docs](https://docs.langchain.com/oss/python/langgraph/overview).
424

525
## Security
626

@@ -91,3 +111,13 @@ async with AsyncSqliteSaver.from_conn_string(":memory:") as checkpointer:
91111
# list checkpoints
92112
[c async for c in checkpointer.alist(read_config)]
93113
```
114+
115+
## πŸ“• Releases & Versioning
116+
117+
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
118+
119+
## πŸ’ Contributing
120+
121+
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
122+
123+
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).

β€Žlibs/checkpoint/README.mdβ€Ž

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
11
# LangGraph Checkpoint
22

3-
This library defines the base interface for LangGraph checkpointers. Checkpointers provide a persistence layer for LangGraph. They allow you to interact with and manage the graph's state. When you use a graph with a checkpointer, the checkpointer saves a _checkpoint_ of the graph state at every superstep, enabling several powerful capabilities like human-in-the-loop, "memory" between interactions and more.
3+
[![PyPI - Version](https://img.shields.io/pypi/v/langgraph-checkpoint?label=%20)](https://pypi.org/project/langgraph-checkpoint/#history)
4+
[![PyPI - License](https://img.shields.io/pypi/l/langgraph-checkpoint)](https://opensource.org/licenses/MIT)
5+
[![PyPI - Downloads](https://img.shields.io/pepy/dt/langgraph-checkpoint)](https://pypistats.org/packages/langgraph-checkpoint)
6+
[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchain_oss.svg?style=social&label=Follow%20%40LangChain)](https://x.com/langchain_oss)
7+
8+
To help you ship LangGraph apps to production faster, check out [LangSmith](https://www.langchain.com/langsmith).
9+
[LangSmith](https://www.langchain.com/langsmith) is a unified developer platform for building, testing, and monitoring LLM applications.
10+
11+
## Quick Install
12+
13+
```bash
14+
uv add langgraph-checkpoint
15+
```
16+
17+
## πŸ€” What is this?
18+
19+
This library defines the base interface for LangGraph checkpointers. Checkpointers provide a persistence layer for LangGraph: they save graph state at every superstep, enabling human-in-the-loop, memory between interactions, durable execution, and more.
20+
21+
## πŸ“– Documentation
22+
23+
For full documentation, see the [API reference](https://reference.langchain.com/python/langgraph.checkpoint). For conceptual guides on persistence and memory, see the [LangGraph Docs](https://docs.langchain.com/oss/python/langgraph/overview).
424

525
## Key concepts
626

@@ -24,7 +44,7 @@ You must pass these when invoking the graph as part of the configurable part of
2444

2545
### Serde
2646

27-
`langgraph_checkpoint` also defines protocol for serialization/deserialization (serde) and provides an default implementation (`langgraph.checkpoint.serde.jsonplus.JsonPlusSerializer`) that handles a wide variety of types, including LangChain and LangGraph primitives, datetimes, enums and more.
47+
`langgraph-checkpoint` also defines protocol for serialization/deserialization (serde) and provides a default implementation (`langgraph.checkpoint.serde.jsonplus.JsonPlusSerializer`) that handles a wide variety of types, including LangChain and LangGraph primitives, datetimes, enums and more.
2848

2949
> [!IMPORTANT]
3050
> **Checkpoint deserialization security:** By default the serializer allows any Python type found in checkpoint data. New applications should set the environment variable `LANGGRAPH_STRICT_MSGPACK=true` or pass an explicit `allowed_msgpack_modules` list to `JsonPlusSerializer` to restrict deserialization to known-safe types.
@@ -89,3 +109,13 @@ checkpointer.get(read_config)
89109
# list checkpoints
90110
list(checkpointer.list(read_config))
91111
```
112+
113+
## πŸ“• Releases & Versioning
114+
115+
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
116+
117+
## πŸ’ Contributing
118+
119+
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
120+
121+
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).

β€Žlibs/cli/README.mdβ€Ž

Lines changed: 62 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,47 @@
11
# LangGraph CLI
22

3-
The official command-line interface for LangGraph, providing tools to create, develop, and deploy LangGraph applications.
3+
[![PyPI - Version](https://img.shields.io/pypi/v/langgraph-cli?label=%20)](https://pypi.org/project/langgraph-cli/#history)
4+
[![PyPI - License](https://img.shields.io/pypi/l/langgraph-cli)](https://opensource.org/licenses/MIT)
5+
[![PyPI - Downloads](https://img.shields.io/pepy/dt/langgraph-cli)](https://pypistats.org/packages/langgraph-cli)
6+
[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchain_oss.svg?style=social&label=Follow%20%40LangChain)](https://x.com/langchain_oss)
47

5-
## Installation
8+
To help you ship LangGraph apps to production faster, check out [LangSmith](https://www.langchain.com/langsmith).
9+
[LangSmith](https://www.langchain.com/langsmith) is a unified developer platform for building, testing, and monitoring LLM applications.
10+
11+
## Quick Install
612

7-
Install via pip:
813
```bash
9-
pip install langgraph-cli
14+
uv add langgraph-cli
1015
```
1116

17+
## πŸ€” What is this?
18+
19+
The LangGraph CLI is the official command-line interface for LangGraph. It provides tools to create, develop, build, and run LangGraph applications locally or in Docker.
20+
21+
## πŸ“– Documentation
22+
23+
For full documentation, see the [LangGraph CLI reference](https://reference.langchain.com/python/langgraph-cli). For conceptual guides and tutorials, see the [LangGraph Docs](https://docs.langchain.com/oss/python/langgraph/overview).
24+
1225
For development mode with hot reloading:
26+
1327
```bash
14-
pip install "langgraph-cli[inmem]"
28+
uv add "langgraph-cli[inmem]"
1529
```
1630

1731
## Commands
1832

1933
### `langgraph new` 🌱
20-
Create a new LangGraph project from a template
34+
35+
Create a new LangGraph project from a template.
36+
2137
```bash
2238
langgraph new [PATH] --template TEMPLATE_NAME
2339
```
2440

2541
### `langgraph dev` πŸƒβ€β™€οΈ
26-
Run LangGraph API server in development mode with hot reloading
42+
43+
Run LangGraph API server in development mode with hot reloading.
44+
2745
```bash
2846
langgraph dev [OPTIONS]
2947
--host TEXT Host to bind to (default: 127.0.0.1)
@@ -35,7 +53,9 @@ langgraph dev [OPTIONS]
3553
```
3654

3755
### `langgraph up` πŸš€
38-
Launch LangGraph API server in Docker
56+
57+
Launch LangGraph API server in Docker.
58+
3959
```bash
4060
langgraph up [OPTIONS]
4161
-p, --port INTEGER Port to expose (default: 8123)
@@ -47,7 +67,9 @@ langgraph up [OPTIONS]
4767
```
4868

4969
### `langgraph build`
50-
Build a Docker image for your LangGraph application
70+
71+
Build a Docker image for your LangGraph application.
72+
5173
```bash
5274
langgraph build -t IMAGE_TAG [OPTIONS]
5375
--platform TEXT Target platforms (e.g., linux/amd64,linux/arm64)
@@ -56,7 +78,9 @@ langgraph build -t IMAGE_TAG [OPTIONS]
5678
```
5779

5880
### `langgraph dockerfile`
59-
Generate a Dockerfile for custom deployments
81+
82+
Generate a Dockerfile for custom deployments.
83+
6084
```bash
6185
langgraph dockerfile SAVE_PATH [OPTIONS]
6286
-c, --config FILE Config file path
@@ -68,38 +92,45 @@ The CLI uses a `langgraph.json` configuration file with these key settings:
6892

6993
```json
7094
{
71-
"dependencies": ["langchain_openai", "./your_package"], // Required: Package dependencies
95+
"dependencies": ["langchain_openai", "./your_package"],
7296
"graphs": {
73-
"my_graph": "./your_package/file.py:graph" // Required: Graph definitions
97+
"my_graph": "./your_package/file.py:graph"
7498
},
75-
"env": "./.env", // Optional: Environment variables
76-
"python_version": "3.11", // Optional: Python version (3.11/3.12)
77-
"pip_config_file": "./pip.conf", // Optional: pip configuration
78-
"dockerfile_lines": [] // Optional: Additional Dockerfile commands
99+
"env": "./.env",
100+
"python_version": "3.11",
101+
"pip_config_file": "./pip.conf",
102+
"dockerfile_lines": []
79103
}
80104
```
81105

82-
See the [full documentation](https://langchain-ai.github.io/langgraph/cloud/reference/cli/) for detailed configuration options.
106+
See the [full documentation](https://reference.langchain.com/python/langgraph-cli) for detailed configuration options.
83107

84108
## Development
85109

86110
To develop the CLI itself:
87111

88112
1. Clone the repository
89113
2. Navigate to the CLI directory: `cd libs/cli`
90-
3. Install development dependencies: `uv pip install`
114+
3. Install development dependencies: `uv sync`
91115
4. Make your changes to the CLI code
92116
5. Test your changes:
93-
```bash
94-
# Run CLI commands directly
95-
uv run langgraph --help
96-
97-
# Or use the examples
98-
cd examples
99-
uv pip install
100-
uv run langgraph dev # or other commands
101-
```
102-
103-
## License
104-
105-
This project is licensed under the terms specified in the repository's LICENSE file.
117+
118+
```bash
119+
# Run CLI commands directly
120+
uv run langgraph --help
121+
122+
# Or use the examples
123+
cd examples
124+
uv sync
125+
uv run langgraph dev # or other commands
126+
```
127+
128+
## πŸ“• Releases & Versioning
129+
130+
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
131+
132+
## πŸ’ Contributing
133+
134+
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
135+
136+
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).

β€Žlibs/cli/js-examples/README.mdβ€Ž

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This template demonstrates a simple chatbot implemented using [LangGraph.js](htt
1010

1111
The core logic, defined in `src/agent/graph.ts`, showcases a straightforward chatbot that responds to user queries while maintaining context from previous messages.
1212

13-
## What it does
13+
## πŸ€” What is this?
1414

1515
The simple chatbot:
1616

@@ -20,6 +20,10 @@ The simple chatbot:
2020

2121
This template provides a foundation that can be easily customized and extended to create more complex conversational agents.
2222

23+
## πŸ“– Documentation
24+
25+
For JavaScript and TypeScript documentation, see the [LangGraph.js docs](https://docs.langchain.com/oss/javascript/langgraph/overview). LangGraph Studio also integrates with [LangSmith](https://smith.langchain.com/) for tracing and collaboration with teammates.
26+
2327
## Getting Started
2428

2529
Assuming you have already [installed LangGraph Studio](https://github.com/langchain-ai/langgraph-studio?tab=readme-ov-file#download), to set up:

0 commit comments

Comments
Β (0)