# Donkeycar: a python self driving library
[](#contributors-)
Donkeycar is minimalist and modular self driving library for Python. It is
developed for hobbyists and students with a focus on allowing fast experimentation and easy
community contributions.
#### Quick Links
* [Donkeycar Updates & Examples](http://donkeycar.com)
* [Build instructions and Software documentation](http://docs.donkeycar.com)
* [Discord / Chat](https://discord.gg/PN6kFeA)
#### Use Donkey if you want to:
* Make an RC car drive its self.
* Compete in self driving races like [DIY Robocars](http://diyrobocars.com)
* Experiment with autopilots, mapping computer vision and neural networks.
* Log sensor data. (images, user inputs, sensor readings)
* Drive your car via a web or game controller or RC controller.
* Leverage community contributed driving data.
* Use existing CAD models for design upgrades.
### Get driving.
After building a Donkey2 you can turn on your car and go to http://localhost:8887 to drive.
### Modify your cars behavior.
The donkey car is controlled by running a sequence of events
```python
#Define a vehicle to take and record pictures 10 times per second.
import time
from donkeycar import Vehicle
from donkeycar.parts.cv import CvCam
from donkeycar.parts.tub_v2 import TubWriter
V = Vehicle()
IMAGE_W = 160
IMAGE_H = 120
IMAGE_DEPTH = 3
#Add a camera part
cam = CvCam(image_w=IMAGE_W, image_h=IMAGE_H, image_d=IMAGE_DEPTH)
V.add(cam, outputs=['image'], threaded=True)
#warmup camera
while cam.run() is None:
time.sleep(1)
#add tub part to record images
tub = TubWriter(path='./dat', inputs=['image'], types=['image_array'])
V.add(tub, inputs=['image'], outputs=['num_records'])
#start the drive loop at 10 Hz
V.start(rate_hz=10)
```
See [home page](http://donkeycar.com), [docs](http://docs.donkeycar.com)
or join the [Discord server](http://www.donkeycar.com/community.html) to learn more.
Raw data
{
"_id": null,
"home_page": "https://github.com/autorope/donkeycar",
"name": "donkeycar",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.11.0",
"maintainer_email": null,
"keywords": "selfdriving cars donkeycar diyrobocars",
"author": "Will Roscoe, Adam Conway, Tawn Kramer",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e2/1a/49fc3843acb5f880e316a436148d5fa4b4abfe1684ea76ae662fb92d72df/donkeycar-5.1.0.tar.gz",
"platform": null,
"description": "# Donkeycar: a python self driving library\n\n\n\n\n\n\n\n[](#contributors-)\n\n\n\n\n\n\n\n\nDonkeycar is minimalist and modular self driving library for Python. It is\ndeveloped for hobbyists and students with a focus on allowing fast experimentation and easy\ncommunity contributions.\n\n#### Quick Links\n* [Donkeycar Updates & Examples](http://donkeycar.com)\n* [Build instructions and Software documentation](http://docs.donkeycar.com)\n* [Discord / Chat](https://discord.gg/PN6kFeA)\n\n\n\n#### Use Donkey if you want to:\n* Make an RC car drive its self.\n* Compete in self driving races like [DIY Robocars](http://diyrobocars.com)\n* Experiment with autopilots, mapping computer vision and neural networks.\n* Log sensor data. (images, user inputs, sensor readings)\n* Drive your car via a web or game controller or RC controller.\n* Leverage community contributed driving data.\n* Use existing CAD models for design upgrades.\n\n### Get driving.\nAfter building a Donkey2 you can turn on your car and go to http://localhost:8887 to drive.\n\n### Modify your cars behavior.\nThe donkey car is controlled by running a sequence of events\n\n```python\n#Define a vehicle to take and record pictures 10 times per second.\n\nimport time\nfrom donkeycar import Vehicle\nfrom donkeycar.parts.cv import CvCam\nfrom donkeycar.parts.tub_v2 import TubWriter\nV = Vehicle()\n\nIMAGE_W = 160\nIMAGE_H = 120\nIMAGE_DEPTH = 3\n\n#Add a camera part\ncam = CvCam(image_w=IMAGE_W, image_h=IMAGE_H, image_d=IMAGE_DEPTH)\nV.add(cam, outputs=['image'], threaded=True)\n\n#warmup camera\nwhile cam.run() is None:\n time.sleep(1)\n\n#add tub part to record images\ntub = TubWriter(path='./dat', inputs=['image'], types=['image_array'])\nV.add(tub, inputs=['image'], outputs=['num_records'])\n\n#start the drive loop at 10 Hz\nV.start(rate_hz=10)\n```\n\nSee [home page](http://donkeycar.com), [docs](http://docs.donkeycar.com)\nor join the [Discord server](http://www.donkeycar.com/community.html) to learn more.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Self driving library for python.",
"version": "5.1.0",
"project_urls": {
"Homepage": "https://github.com/autorope/donkeycar"
},
"split_keywords": [
"selfdriving",
"cars",
"donkeycar",
"diyrobocars"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "13d8cb19317b2ebb200c4a133c3a8944bbfdaa15d1f0228b05900f7ecaf06954",
"md5": "4ce08de885dbc02e86bcb1c89bb321bd",
"sha256": "91482cb885bbf43f452a4302973f91017e475fee9e10597dd34d2190168cdbaa"
},
"downloads": -1,
"filename": "donkeycar-5.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ce08de885dbc02e86bcb1c89bb321bd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.11.0",
"size": 657898,
"upload_time": "2024-04-01T17:08:57",
"upload_time_iso_8601": "2024-04-01T17:08:57.588142Z",
"url": "https://files.pythonhosted.org/packages/13/d8/cb19317b2ebb200c4a133c3a8944bbfdaa15d1f0228b05900f7ecaf06954/donkeycar-5.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e21a49fc3843acb5f880e316a436148d5fa4b4abfe1684ea76ae662fb92d72df",
"md5": "ba23b8af45c79110e3ba9a8bd832e936",
"sha256": "3c0807a709fd309136fc64803cc48e4a6265af1393319f9ce9335650ce8e2ad6"
},
"downloads": -1,
"filename": "donkeycar-5.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ba23b8af45c79110e3ba9a8bd832e936",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.11.0",
"size": 588457,
"upload_time": "2024-04-01T17:09:00",
"upload_time_iso_8601": "2024-04-01T17:09:00.867070Z",
"url": "https://files.pythonhosted.org/packages/e2/1a/49fc3843acb5f880e316a436148d5fa4b4abfe1684ea76ae662fb92d72df/donkeycar-5.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 17:09:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "autorope",
"github_project": "donkeycar",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "donkeycar"
}
JSON
