Merge pull request #74 from autonomousvision/dev_v0.0.8

Merge `dev_v0.0.8` branch into `main`

Author: DanielDauner

.flake8

@@ -3,7 +3,7 @@ name: docs
 on:
   push:
     branches:
-      - main # Change this to your branch name (e.g., docs, dev, etc.)
+      - main
   workflow_dispatch:  # Allows manual triggering
 
 permissions:

.github/workflows/deploy-docs.yaml

@@ -0,0 +1,14 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+    - uses: pre-commit/[email protected]

.github/workflows/pre-commit.yaml

@@ -0,0 +1,26 @@
+name: pytest
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          pip install uv
+          uv pip install --system -e ".[dev]"
+      - name: Test with pytest
+        run: |
+          pytest

.github/workflows/pytest.yaml

@@ -24,11 +24,14 @@
 *.log
 *.mp4
 exp/
+.coverage
 
 # Sphinx documentation
 docs/_build/
 docs/build/
 _build/
 .doctrees/
 
-jbwang_*
+
+# ruff
+.ruff_cache/*

.gitignore

@@ -18,31 +18,14 @@ repos:
         exclude: /README\.rst$|\.pot?$|\.ipynb$
         args: ['--no-sort-keys', "--autofix"]
 
--   repo: https://github.com/pycqa/isort
-    rev: 6.0.1
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.6
     hooks:
-      - id: isort
-        name: isort (python)
-        args: ["--profile", "black", "--filter-files", '--line-length', '120']
+      - id: ruff-check  # Run the linter.
+        args: [--fix]
+        exclude: __init__.py$
+      - id: ruff-format  # Run the formatter.
         exclude: __init__.py$
--   repo: https://github.com/ambv/black
-    rev: 25.1.0
-    hooks:
-    - id: black
-      language_version: python3.12
-      args: ['--line-length=120']
-      files: "\\.py$"
--   repo: https://github.com/myint/autoflake
-    rev: v2.3.1
-    hooks:
-    - id: autoflake
-      args: ['--in-place', '--remove-all-unused-imports', '--remove-unused-variable']
-      exclude: __init__.py$
-      language_version: python3.12
--   repo: https://github.com/pycqa/flake8
-    rev: 7.3.0
-    hooks:
-    - id: flake8
 -   repo: https://github.com/kynan/nbstripout
     rev: 0.8.1
     hooks:

.isort.cfg

@@ -1,8 +1,30 @@
 <h1 align="center">
   <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="assets/logo/123D_logo_transparent_white.svg" width="500">
-    <source media="(prefers-color-scheme: light)" srcset="assets/logo/123D_logo_transparent_black.svg" width="500">
-    <img alt="Logo" src="assets/logo/123D_logo_transparent_black.svg" width="500">
+    <source media="(prefers-color-scheme: dark)" srcset="https://autonomousvision.github.io/py123d/_static/123D_logo_transparent_white.svg" width="500">
+    <source media="(prefers-color-scheme: light)" srcset="https://autonomousvision.github.io/py123d/_static/123D_logo_transparent_black.svg" width="500">
+    <img alt="Logo" src="https://autonomousvision.github.io/py123d/_static/123D_logo_transparent_black.svg" width="500">
   </picture>
-  <h2 align="center">123D: One Library for 2D and 3D Driving Datasets</h1>
+  <h2 align="center">123D: A Library for Driving Datasets</h1>
+  <h3 align="center"><a href="https://youtu.be/Q4q29fpXnx8">Video</a> | <a href="https://autonomousvision.github.io/py123d/">Documentation</a>
 </h1>
+
+
+## Features
+
+- Unified API for driving data, including sensor data, maps, and labels.
+- Support for multiple sensors storage formats.
+- Fast dataformat based on [Apache Arrow](https://arrow.apache.org/).
+- Visualization tools with [matplotlib](https://matplotlib.org/) and [Viser](https://viser.studio/main/).
+
+
+> **Warning**
+>
+> This library is under active development and not stable. The API and features may change in future releases.
+> Please report issues, feature requests, or other feedback by opening an issue.
+
+
+## Changelog
+
+- **`[2025-11-21]`** v0.0.8 (silent release)
+  - Release of package and documentation.
+  - Demo data for tutorials.

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+You can install relevant dependencies for editing the public documentation via:
+```sh
+pip install -e .[docs]
+```
+
+It is recommended to uses [sphinx-autobuild](https://github.com/sphinx-doc/sphinx-autobuild) (installed above) to edit and view the documentation. You can run:
+
+```sh
+sphinx-autobuild docs docs/_build/html
+```