Skip to content

Commit 0e61b17

Browse files
committed
Update install instructions for PyPI release
1 parent 1055197 commit 0e61b17

2 files changed

Lines changed: 24 additions & 7 deletions

File tree

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
<h2>⚒ Robotics Data Toolkit ⚒</h2>
1111
<i>Convert, inspect, visualize, score, and discover robotics datasets across every major format.</i>
1212
<br><br>
13+
<a href="https://pypi.org/project/forge-robotics/"><img alt="PyPI" src="https://img.shields.io/pypi/v/forge-robotics?style=flat-square&color=6c9fff"></a>
1314
<a href="https://arpitg1304.github.io/forge/"><img alt="Website" src="https://img.shields.io/badge/website-live-6c9fff?style=flat-square"></a>
1415
<a href="https://github.com/arpitg1304/forge"><img alt="Python 3.10+" src="https://img.shields.io/badge/python-3.10%2B-blue?style=flat-square"></a>
1516
<a href="https://github.com/arpitg1304/forge/blob/main/LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-green?style=flat-square"></a>
@@ -50,10 +51,26 @@ Add a reader, get all writers for free. Add a writer, get all readers for free.
5051

5152
## Quick Start
5253

54+
```bash
55+
pip install forge-robotics # base CLI + LeRobot v3 read/write
56+
pip install "forge-robotics[mcap]" # add MCAP read/write
57+
pip install "forge-robotics[rlds,lerobot]" # pick the formats you need
58+
pip install "forge-robotics[all]" # everything
59+
```
60+
61+
That gives you the `forge` CLI:
62+
```bash
63+
forge inspect path/to/dataset
64+
forge convert path/to/dataset ./out --format lerobot-v3
65+
forge visualize path/to/dataset
66+
```
67+
68+
### Develop from source
69+
5370
```bash
5471
git clone https://github.com/arpitg1304/forge.git
5572
cd forge
56-
pip install -e ".[all]"
73+
pip install -e ".[all,dev]"
5774
```
5875

5976
### RoboDM Support (Optional)

docs/index.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -702,8 +702,8 @@
702702
</a>
703703
</div>
704704
<div class="install-bar">
705-
<code><span class="dollar">$ </span><span class="cmd">pip install</span> -e ".[all]"</code>
706-
<button class="copy-btn" onclick="copyText(this, 'pip install -e \".[all]\"')">
705+
<code><span class="dollar">$ </span><span class="cmd">pip install</span> "forge-robotics[all]"</code>
706+
<button class="copy-btn" onclick="copyText(this, 'pip install &quot;forge-robotics[all]&quot;')">
707707
<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><rect x="9" y="9" width="13" height="13" rx="2"/><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"/></svg>
708708
</button>
709709
</div>
@@ -1299,11 +1299,11 @@ <h2 class="section-title">Up and running in 60 seconds</h2>
12991299
<div class="step-card">
13001300
<div class="step-num">1</div>
13011301
<div class="step-title">Install</div>
1302-
<div class="step-desc">Clone the repo and install with pip.</div>
1302+
<div class="step-desc">One pip install — pick the format extras you need (or grab everything).</div>
13031303
<div class="feature-code">
1304-
<span class="prompt">$ </span><span class="cmd">git clone</span> <span class="arg">https://github.com/arpitg1304/forge.git</span><br>
1305-
<span class="prompt">$ </span><span class="cmd">cd</span> forge<br>
1306-
<span class="prompt">$ </span><span class="cmd">pip install</span> -e <span class="arg">".[all]"</span>
1304+
<span class="prompt">$ </span><span class="cmd">pip install</span> <span class="arg">"forge-robotics[mcap]"</span><br>
1305+
<span class="comment"># or for every supported format:</span><br>
1306+
<span class="prompt">$ </span><span class="cmd">pip install</span> <span class="arg">"forge-robotics[all]"</span>
13071307
</div>
13081308
</div>
13091309

0 commit comments

Comments
 (0)