search

dronekit / dronekit-python

DroneKit-Python library for communicating with Drones via MAVLink.
https://readthedocs.org/projects/dronekit-python/
Apache License 2.0
1.59k stars 1.44k forks source link

(Suggestion) Mention virtualenv in "Getting Started" #472

Open atomictom opened 8 years ago

atomictom commented 8 years ago

I recommend adding a section on virtualenv (+ virtualenvwrapper?) in the Getting Started page. Given how quickly things are still changing with DroneKit-Python (which is good!) I think anyone writing code that they want to deploy or upgrade would benefit from virtualenv. It'd be helpful both in allowing you to install an older version of dronekit if your app/script relies on that, and in safely testing new versions. I'd be willing to give it a shot in a few days, but I wanted to mention it now so anyone can chime in with any additional suggestions.

Thanks!

hamishwillee commented 8 years ago

Hi @atomictom

Great idea ... but:

I see virtualenv as a deployment solution not as a getting started topic. I do agree that it is a useful model for defining a common environment (and is what is used in Solo). So we can link from gettting started but this should not be fully documented there.

I'm not an expert so would really appreciate if you could write this (as a standalone topic - part of "Deploying a script"). Can this have test and example code that i can run on Windows/Linux/Mac?

Thanks!