simple-autonomous-car 0.1.2__tar.gz

simple_autonomous_car-0.1.2/.github/workflows/ci.yml

@@ -0,0 +1,74 @@
+name: CI
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - name: Run black
+        run: black --check .
+      - name: Run ruff
+        run: ruff check .
+      - name: Run mypy
+        run: mypy .
+
+  test:
+    name: Test Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - name: Run tests
+        run: pytest --cov=src --cov-report=xml --cov-report=term-missing
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false
+
+  build:
+    name: Build package
+    runs-on: ubuntu-latest
+    needs: [lint, test]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Check package
+        run: pip install twine && twine check dist/*

simple_autonomous_car-0.1.2/.github/workflows/publish.yml

@@ -0,0 +1,103 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published, edited]
+  # Note: We use GitHub Releases instead of direct tag pushes for:
+  # - Better visibility and release notes
+  # - More intentional publishing (less accidental)
+  # - Better control with environment protection rules
+  # 'edited' type allows re-running by editing the release
+  # If you need tag-only publishing, uncomment below:
+  # push:
+  #   tags:
+  #     - "v*"
+
+jobs:
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/simple_autonomous_car/
+    permissions:
+      contents: read
+      id-token: write  # Required for PyPI trusted publishing
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Fetch all history for version detection
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Extract version from release tag
+        id: tag_version
+        env:
+          TAG_NAME: ${{ github.event.release.tag_name }}
+        run: |
+          # GitHub releases provide the tag in github.event.release.tag_name
+          # Remove 'v' prefix if present
+          if [[ "$TAG_NAME" == v* ]]; then
+            VERSION=${TAG_NAME#v}
+          else
+            VERSION="$TAG_NAME"
+          fi
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "Release tag: $TAG_NAME"
+          echo "Release version: $VERSION"
+
+      - name: Verify version matches pyproject.toml
+        run: |
+          pip install tomli
+          PYPROJECT_VERSION=$(python -c "import tomli; print(tomli.load(open('pyproject.toml', 'rb'))['project']['version'])")
+          TAG_VERSION="${{ steps.tag_version.outputs.version }}"
+          if [ "$PYPROJECT_VERSION" != "$TAG_VERSION" ]; then
+            echo "Error: Version mismatch!"
+            echo "pyproject.toml version: $PYPROJECT_VERSION"
+            echo "Tag version: $TAG_VERSION"
+            exit 1
+          fi
+          echo "✓ Version matches: $PYPROJECT_VERSION"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check package
+        run: twine check dist/*
+
+      - name: Check if pre-release
+        id: check_prerelease
+        run: |
+          if [ "${{ github.event.release.prerelease }}" == "true" ]; then
+            echo "skip=true" >> $GITHUB_OUTPUT
+            echo "⚠️  Pre-release detected - skipping PyPI publish"
+          else
+            echo "skip=false" >> $GITHUB_OUTPUT
+            echo "✓ Final release - will publish to PyPI"
+          fi
+
+      - name: Publish to PyPI
+        if: steps.check_prerelease.outputs.skip == 'false'
+        # Option 1: PyPI Trusted Publishing (Recommended)
+        # Configure at: https://pypi.org/manage/account/publishing/
+        # Add your repository URL and workflow name
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+          print-hash: true
+
+      # Option 2: Using API Token (Alternative)
+      # Uncomment below and comment out the above step if using API token
+      # - name: Publish to PyPI
+      #   env:
+      #     TWINE_USERNAME: __token__
+      #     TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+      #   run: twine upload dist/* --verbose

simple_autonomous_car-0.1.2/.gitignore

@@ -0,0 +1,60 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+venv/
+env/
+ENV/
+.venv
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.hypothesis/
+
+# Type checking
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pre-commit
+.pre-commit-cache/
+
+# Project specific
+*.png
+*.jpg
+*.gif
+outputs/
+logs/
+
+# OS
+.DS_Store
+Thumbs.db

simple_autonomous_car-0.1.2/.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-json
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: debug-statements
+
+  - repo: https://github.com/psf/black
+    rev: 23.12.1
+    hooks:
+      - id: black
+        language_version: python3
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.9
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+      - id: mypy
+        additional_dependencies: [types-all]
+        args: [--ignore-missing-imports]

simple_autonomous_car-0.1.2/CHANGELOG.md

@@ -0,0 +1,95 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2026-XX-XX
+
+### Added
+- **Modular Sensor System**: Complete sensor architecture
+  - `BaseSensor` abstract class for all sensors
+  - `LiDARSensor` implementation
+  - Car can have multiple sensors via `car.add_sensor()`
+  - Sensors can be enabled/disabled individually
+
+- **Control System**: Complete control architecture
+  - `BaseController` abstract class
+  - `PurePursuitController` for path following
+  - `PIDController` for PID control
+  - Controllers work with plans from planners
+
+- **Planning System**: Path planning framework
+  - `BasePlanner` abstract class
+  - `TrackPlanner` for track following
+  - Planners generate waypoints for controllers
+
+- **Enhanced Car Class**:
+  - Support for multiple sensors
+  - `car.add_sensor()`, `car.remove_sensor()`, `car.get_sensor()`
+  - `car.sense_all()` to get data from all sensors
+
+- **Controller Notebook**: Interactive tutorial for building controllers
+
+### Changed
+- **Project Renamed**: From `car-loc-viz` to `simple-autonomous-car`
+- **Package Renamed**: From `car_loc_viz` to `simple_autonomous_car`
+- **Architecture**: Modular OOP design with pluggable components
+- **Sensor System**: Replaced single `Sensor` class with modular `BaseSensor` system
+
+### Removed
+- Old `Sensor` class (replaced by modular sensor system)
+
+## [0.0.2] - 2026-XX-XX
+
+### Added
+- **Frenet Frame Support**: Complete Frenet coordinate system implementation
+  - `FrenetFrame` class for path-aligned coordinates
+  - Conversion utilities: `global_to_frenet`, `frenet_to_global`, `ego_to_frenet`, `frenet_to_ego`, `sensor_to_ego`, `ego_to_sensor`
+  - `FrenetMap` for map representation in Frenet coordinates
+
+- **PerceptionPoints**: New data structure for perception data
+  - Vector of points in local (ego) frame
+  - Frame conversion utilities
+  - Distance filtering
+
+- **Alert System**: Track Bounds Alert System
+  - `TrackBoundsAlert` class for detecting boundary deviations
+  - Comprehensive documentation
+  - Jupyter notebook with examples
+
+- **Documentation**:
+  - Building on Top guide
+  - Track Bounds Alert System documentation
+  - Jupyter notebook tutorials
+
+- **CI/CD**:
+  - GitHub Actions workflows for lint, test, and build
+  - PyPI publishing workflow
+  - Multi-platform testing (Linux, Windows, macOS)
+  - Multiple Python version support (3.10, 3.11, 3.12)
+
+- **SDK Structure**:
+  - Clean module organization
+  - Comprehensive `__init__.py` exports
+  - Type hints throughout
+  - Error handling
+
+### Changed
+- Refactored code structure for better modularity
+- Updated sensor to return `PerceptionPoints` instead of raw arrays
+- Improved project metadata for PyPI publishing
+- Enhanced documentation structure
+
+### Fixed
+- Frame conversion utilities
+- Error handling in alert system
+- Import structure
+
+## [0.0.1] - 2026-XX-XX
+
+### Added
+- Initial release
+- Basic track generation
+- Car model and dynamics
+- Ground truth and perceived maps
+- Basic visualization
+- Error detection

simple_autonomous_car-0.1.2/CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# Contributing to Car Loc Viz SDK
+
+Thank you for your interest in contributing! This document provides guidelines for contributing to the project.
+
+## Development Setup
+
+1. Fork the repository
+2. Clone your fork:
+   ```bash
+   git clone https://github.com/yourusername/car-loc-viz.git
+   cd car-loc-viz
+   ```
+3. Install development dependencies:
+   ```bash
+   uv sync --dev
+   ```
+4. Install pre-commit hooks:
+   ```bash
+   uv run pre-commit install
+   ```
+
+## Code Style
+
+- Follow PEP 8 style guidelines
+- Use `black` for formatting (line length: 100)
+- Use `ruff` for linting
+- Use `mypy` for type checking
+- Maximum line length: 100 characters
+
+## Testing
+
+- Write tests for all new features
+- Ensure all tests pass: `uv run pytest`
+- Aim for high test coverage
+- Add tests to appropriate files in `tests/`
+
+## Documentation
+
+- Update docstrings for all new functions/classes
+- Follow NumPy docstring format
+- Update relevant documentation files
+- Add examples if applicable
+
+## Pull Request Process
+
+1. Create a feature branch from `main`
+2. Make your changes
+3. Ensure tests pass and code is linted
+4. Update documentation
+5. Submit a pull request with a clear description
+
+## Commit Messages
+
+- Use clear, descriptive commit messages
+- Reference issues when applicable
+- Follow conventional commit format when possible
+
+## Questions?
+
+Open an issue for questions or discussions about contributions.