feat: add uv for project management and publishing workflow to pypi

Author: aditya-neuraco

.github/workflows/build.yaml

@@ -11,25 +11,31 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - name: Check out repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+
     - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: "3.11"
-    - name: Install dependencies
+      run: uv python install 3.11
+
+    - name: Install system dependencies
       run: |
         sudo apt-get update
         sudo apt-get install -y libxml2-utils xvfb libgl1-mesa-dev libgl1-mesa-glx libosmesa6-dev
-        python -m pip install --upgrade pip
-        pip install ".[dev]"
-        pip install pre-commit
+
+    - name: Install dependencies
+      run: uv sync --extra dev
+
     - name: Run pre-commit checks
-      run: pre-commit run --all-files
+      run: uv run pre-commit run --all-files
+
     - name: Start Xvfb
       run: |
         Xvfb :99 -ac &
         echo "DISPLAY=:99" >> $GITHUB_ENV
+
     - name: Run tests
       env:
         DISPLAY: :99
-      run: pytest tests/
+      run: uv run pytest tests/

.github/workflows/publish.yaml

@@ -0,0 +1,73 @@
+name: Publish to TestPyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python
+        run: uv python install 3.11
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-testpypi:
+    name: Publish to TestPyPI
+    needs: build
+    runs-on: ubuntu-22.04
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/project/bigym/
+    permissions:
+      id-token: write  # Required for trusted publishing
+
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  # TODO: Uncomment when publishing to PyPI
+  # publish-to-pypi:
+  #   name: Publish to PyPI
+  #   if: github.event_name == 'release'
+  #   needs: build
+  #   runs-on: ubuntu-22.04
+  #   environment:
+  #     name: pypi
+  #     url: https://pypi.org/project/bigym/
+  #   permissions:
+  #     id-token: write  # Required for trusted publishing
+  #
+  #   steps:
+  #     - name: Download distribution artifacts
+  #       uses: actions/download-artifact@v4
+  #       with:
+  #         name: python-package-distributions
+  #         path: dist/
+  #
+  #     - name: Publish to PyPI
+  #       uses: pypa/gh-action-pypi-publish@release/v1

README.md

@@ -3,8 +3,8 @@
 </h1>
 
 <p>
-  <a href="https://github.com/chernyadev/bigym/actions/workflows/build.yaml?query=branch%3Amaster" alt="GitHub Actions">
-    <img src="https://img.shields.io/github/actions/workflow/status/chernyadev/bigym/build.yaml?branch=master">
+  <a href="https://github.com/NeuracoreAI/bigym/actions/workflows/build.yaml?query=branch%3Amaster" alt="GitHub Actions">
+    <img src="https://img.shields.io/github/actions/workflow/status/NeuracoreAI/bigym/build.yaml?branch=master">
   </a>
   <a href="#contributing">
     <img src="https://img.shields.io/badge/PRs-welcome-green.svg" alt="PRs" height="20">

bigym/envs/xmls/3D_MODELS_ATTRIBUTION.md

@@ -17,7 +17,7 @@ This document provides the attribution details for the 3D models included in thi
 
 ## Groceries
 
-- **Asset(s)**: [`bigym/envs/xmls/props/groceries/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/groceries/assets)
+- **Asset(s)**: [`bigym/envs/xmls/props/groceries/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/groceries/assets)
 - **Author**: [tulex_art](https://sketchfab.com/CassioFernandes)
 - **Source**: [Sketchfab](https://skfb.ly/6RCNy)
 - **License**: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
@@ -26,7 +26,7 @@ This document provides the attribution details for the 3D models included in thi
 
 ## Kitchen Set
 
-- **Asset(s)**: [`bigym/envs/xmls/props/kitchen/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/kitchen/assets)
+- **Asset(s)**: [`bigym/envs/xmls/props/kitchen/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/kitchen/assets)
 - **Author**: [RedKit](https://sketchfab.com/redkitpro)
 - **Source**: [Sketchfab](https://skfb.ly/6SXBW)
 - **License**: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
@@ -36,13 +36,13 @@ This document provides the attribution details for the 3D models included in thi
 ## Kitchen Utensils
 
 - **Asset(s)**:
-  - [`bigym/envs/xmls/props/board/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/board/assets)
-  - [`bigym/envs/xmls/props/pan/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/pan/assets)
-  - [`bigym/envs/xmls/props/saucepan/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/saucepan/assets)
-  - [`bigym/envs/xmls/props/spatula/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/spatula/assets)
-  - [`bigym/envs/xmls/props/groceries/detergent/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/groceries/detergent/assets)
-  - [`bigym/envs/xmls/props/groceries/soap/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/groceries/soap/assets)
-  - [`bigym/envs/xmls/props/groceries/wine/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/groceries/wine/assets)
+  - [`bigym/envs/xmls/props/board/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/board/assets)
+  - [`bigym/envs/xmls/props/pan/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/pan/assets)
+  - [`bigym/envs/xmls/props/saucepan/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/saucepan/assets)
+  - [`bigym/envs/xmls/props/spatula/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/spatula/assets)
+  - [`bigym/envs/xmls/props/groceries/detergent/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/groceries/detergent/assets)
+  - [`bigym/envs/xmls/props/groceries/soap/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/groceries/soap/assets)
+  - [`bigym/envs/xmls/props/groceries/wine/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/groceries/wine/assets)
 - **Author**: [Nicolai Kilstrup](https://sketchfab.com/nkilstrup)
 - **Source**: [Sketchfab](https://skfb.ly/oFoUn)
 - **License**: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
@@ -51,7 +51,7 @@ This document provides the attribution details for the 3D models included in thi
 
 ## Box
 
-- **Asset(s)**: [`bigym/envs/xmls/props/box/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/box/assets)
+- **Asset(s)**: [`bigym/envs/xmls/props/box/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/box/assets)
 - **Author**: [Pricey1600](https://sketchfab.com/Pricey1600)
 - **Source**: [Sketchfab](https://skfb.ly/6ZWFF)
 - **License**: [CC BY NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/)
@@ -61,9 +61,9 @@ This document provides the attribution details for the 3D models included in thi
 ## Cutlery
 
 - **Asset(s)**:
-  - [`bigym/envs/xmls/props/cutlery/knife/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/cutlery/knife/assets)
-  - [`bigym/envs/xmls/props/cutlery/fork/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/cutlery/fork/assets)
-  - [`bigym/envs/xmls/props/cutlery/spoon/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/cutlery/spoon/assets)
+  - [`bigym/envs/xmls/props/cutlery/knife/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/cutlery/knife/assets)
+  - [`bigym/envs/xmls/props/cutlery/fork/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/cutlery/fork/assets)
+  - [`bigym/envs/xmls/props/cutlery/spoon/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/cutlery/spoon/assets)
 - **Author**: [thebasemesh.com](https://thebasemesh.com)
 - **Source**: [thebasemesh.com](https://thebasemesh.com)
 - **License**: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
@@ -73,8 +73,8 @@ This document provides the attribution details for the 3D models included in thi
 ## Tables
 
 - **Asset(s)**:
-  - [`bigym/envs/xmls/props/table/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/table/assets)
-  - [`bigym/envs/xmls/props/table_dishwasher/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/table_dishwasher/assets)
+  - [`bigym/envs/xmls/props/table/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/table/assets)
+  - [`bigym/envs/xmls/props/table_dishwasher/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/table_dishwasher/assets)
 - **Author**: [thebasemesh.com](https://thebasemesh.com)
 - **Source**: [thebasemesh.com](https://thebasemesh.com)
 - **License**: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
@@ -83,7 +83,7 @@ This document provides the attribution details for the 3D models included in thi
 
 ## Plate
 
-- **Asset(s)**: [`bigym/envs/xmls/props/plate/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/plate/assets)
+- **Asset(s)**: [`bigym/envs/xmls/props/plate/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/plate/assets)
 - **Author**: [thebasemesh.com](https://thebasemesh.com)
 - **Source**: [thebasemesh.com](https://thebasemesh.com)
 - **License**: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
@@ -92,7 +92,7 @@ This document provides the attribution details for the 3D models included in thi
 
 ## Mug
 
-- **Asset(s)**: [`bigym/envs/xmls/props/mug/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/mug/assets)
+- **Asset(s)**: [`bigym/envs/xmls/props/mug/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/mug/assets)
 - **Author**: [thebasemesh.com](https://thebasemesh.com)
 - **Source**: [thebasemesh.com](https://thebasemesh.com)
 - **License**: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
@@ -101,7 +101,7 @@ This document provides the attribution details for the 3D models included in thi
 
 ## Cutlery Tray
 
-- **Asset(s)**: [`bigym/envs/xmls/props/cutlery_tray/assets`](https://github.com/chernyadev/bigym/tree/master/bigym/envs/xmls/props/cutlery_tray/assets)
+- **Asset(s)**: [`bigym/envs/xmls/props/cutlery_tray/assets`](https://github.com/NeuracoreAI/bigym/tree/master/bigym/envs/xmls/props/cutlery_tray/assets)
 - **Author**: [thebasemesh.com](https://thebasemesh.com)
 - **Source**: [thebasemesh.com](https://thebasemesh.com)
 - **License**: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)

pyproject.toml

@@ -0,0 +1,82 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "bigym"
+dynamic = ["version"]
+description = "BiGym: A Demo-Driven Mobile Bi-Manual Manipulation Benchmark"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+authors = [
+    { name = "Nikita Cherniadev", email = "[email protected]" }
+]
+keywords = [
+    "robotics",
+    "reinforcement-learning",
+    "benchmark",
+    "manipulation",
+    "mujoco",
+    "gymnasium",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Scientific/Engineering :: Robotics",
+]
+dependencies = [
+    # includes bugfix in mujoco_rendering
+    "gymnasium @ git+https://github.com/stepjam/[email protected]",
+    # pyquaternion doesn't support 2.x yet
+    "numpy==1.26.*",
+    "safetensors==0.3.3",
+    # WARNING: recorded demos might break when updating Mujoco
+    "mujoco==3.1.5",
+    # needed for pyMJCF
+    "dm_control==1.0.19",
+    "imageio",
+    "pyquaternion",
+    "mujoco_utils",
+    "wget",
+    "mojo @ git+https://github.com/stepjam/[email protected]",
+    "pyyaml",
+    "dearpygui",
+    "pyopenxr<1.1.5001", 
+]
+
+[project.optional-dependencies]
+dev = ["pre-commit", "pytest"]
+examples = [
+    "moviepy",
+    "pygame",
+    "opencv-python",
+    "matplotlib",
+]
+all = ["bigym[dev,examples]"]
+
+[project.urls]
+Homepage = "https://chernyadev.github.io/bigym/"
+Documentation = "https://github.com/NeuracoreAI/bigym#readme"
+Repository = "https://github.com/NeuracoreAI/bigym"
+"Bug Tracker" = "https://github.com/NeuracoreAI/bigym/issues"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.dynamic]
+version = { attr = "bigym.__version__" }
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["bigym*", "demonstrations*", "tools*", "vr*"]
+
+[tool.setuptools.package-data]
+"*" = ["*.yaml", "*.xml"]

setup.py

@@ -1,65 +1,5 @@
-import codecs
-import os
-from pathlib import Path
+# This file is kept for backwards compatibility with legacy installations.
+# All configuration has been moved to pyproject.toml.
+from setuptools import setup
 
-import setuptools
-
-
-def read(rel_path):
-    here = os.path.abspath(os.path.dirname(__file__))
-    with codecs.open(os.path.join(here, rel_path), "r") as fp:
-        return fp.read()
-
-
-def get_version(rel_path):
-    for line in read(rel_path).splitlines():
-        if line.startswith("__version__"):
-            delim = '"' if '"' in line else "'"
-            return line.split(delim)[1]
-    else:
-        raise RuntimeError("Unable to find version string.")
-
-
-core_requirements = [
-    # includes bugfix in mujoco_rendering
-    "gymnasium @ git+https://[email protected]/stepjam/[email protected]",
-    # pyquaternion doesn't support 2.x yet
-    "numpy==1.26.*",
-    "safetensors==0.3.3",
-    # WARNING: recorded demos might break when updating Mujoco
-    "mujoco==3.1.5",
-    # needed for pyMJCF
-    "dm_control==1.0.19",
-    "imageio",
-    "pyquaternion",
-    "mujoco_utils",
-    "wget",
-    "mojo @ git+https://[email protected]/stepjam/[email protected]",
-    "pyyaml",
-    "dearpygui",
-    "pyopenxr",
-]
-
-setuptools.setup(
-    version=get_version("bigym/__init__.py"),
-    name="bigym",
-    author="Nikita Cherniadev",
-    author_email="[email protected]",
-    packages=setuptools.find_packages(),
-    python_requires=">=3.10",
-    install_requires=core_requirements,
-    package_data={
-        "": [str(p.resolve()) for p in Path("bigym/envs/xmls").glob("**/*")]
-        + [str(p.resolve()) for p in Path("bigym/envs/presets").glob("**/*.yaml")]
-        + [str(p.resolve()) for p in Path("vr/viewer/xmls").glob("**/*")]
-    },
-    extras_require={
-        "dev": ["pre-commit", "pytest"],
-        "examples": [
-            "moviepy",
-            "pygame",
-            "opencv-python",
-            "matplotlib",
-        ],
-    },
-)
+setup()