Skip to main content

DonkeyDrifter autonomous driving and drifting robotics platform derived from Donkeycar.

Project description

DonkeyDrifter

DonkeyDrifter is a Python autonomous driving and drifting robotics platform derived from Donkeycar. It keeps the modular Vehicle + Part architecture, Tub data workflow, training tools, simulator support, and Web UI workflows while establishing an independent DonkeyDrifter identity.

Independent fork notice: DonkeyDrifter is derived from Donkeycar and is not affiliated with, sponsored by, or endorsed by the Donkeycar maintainers.

Quick Start

pip install donkeydrifter
donkey createcar --path ~/mycar --template complete
cd ~/mycar
python manage.py drive

The CLI command remains donkey for compatibility with the Donkeycar ecosystem and existing vehicle projects.

For local development:

pip install -e ".[pc,dev]"
pytest

Python Imports

Recommended for new DonkeyDrifter code:

import donkeydrifter as dk

Legacy Donkeycar imports continue to work:

import donkeycar as dk

Submodule imports are also compatible. New templates prefer donkeydrifter, while existing vehicle directories using donkeycar do not need to be changed immediately.

Compatibility with Donkeycar

DonkeyDrifter is intentionally compatible with existing Donkeycar-based projects during the migration period:

  • pip install donkeydrifter is the new package target.
  • import donkeydrifter as dk is the recommended import path for new code.
  • import donkeycar as dk remains supported as a compatibility path.
  • CLI command remains donkey.
  • Existing vehicle projects can migrate gradually.
  • Existing /api/* Web UI paths and drive WebSocket protocols are not renamed in the first migration stage.

See Donkeycar compatibility guide for details.

Web UI

DonkeyDrifter includes a unified Web UI under web_ui/:

  • Backend: FastAPI, default port 8000.
  • Frontend: React/Vite, default port 5188.
  • Integrated startup remains available through:
donkey installweb --path ./web_ui
donkey web

Development

Common commands:

pytest
pytest donkeycar/tests/test_vehicle.py -q
python -m build --sdist --wheel

Web UI backend:

cd web_ui/backend
python -m pytest tests -q

Web UI frontend:

cd web_ui/frontend
npm run check
npm run lint
npm run build

License

DonkeyDrifter uses the Apache License 2.0 as its primary project license.

DonkeyDrifter is derived from Donkeycar. Portions originating from Donkeycar remain licensed under the MIT License. See:

Acknowledgements

DonkeyDrifter is derived from the Donkeycar project:

https://github.com/autorope/donkeycar

We thank the Donkeycar maintainers and contributors for their work.

Some historical documentation links may still point to upstream Donkeycar resources. Such links are retained as attribution or compatibility references and may differ from DonkeyDrifter behavior.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

donkeydrifter-0.1.0.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

donkeydrifter-0.1.0-py3-none-any.whl (3.6 MB view details)

Uploaded Python 3

File details

Details for the file donkeydrifter-0.1.0.tar.gz.

File metadata

  • Download URL: donkeydrifter-0.1.0.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for donkeydrifter-0.1.0.tar.gz
Algorithm Hash digest
SHA256 cda27759e40b2bc8274346ecfb5def4d3e2984d9efb18a52aaa7385f4709a35b
MD5 b793dcfc89c7103dbda317703b8626ba
BLAKE2b-256 9a5700e5e73b576a4907273b8b4ba3ba668fcce8a760c437206cd816928c3e07

See more details on using hashes here.

File details

Details for the file donkeydrifter-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: donkeydrifter-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for donkeydrifter-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 62f02f809480c6f14a561a5a0d8019d548940409e146e5d12cc73eed90a632cb
MD5 6b48894bfd977e87c3441630d3e8ec93
BLAKE2b-256 f9aff52fa91b47d5963179c93fd8585cdd3321f1a39252b5b29c43e0aa8e5269

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page