Skip to content

Commit 4e20771

Browse files
committed
Renames "droneapi" to "dronekit".
1 parent 09db97c commit 4e20771

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+151
-336
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.project
22
.pydevproject
3-
droneapi.egg-info
3+
dronekit.egg-info
44
dist
55
build
66
.vagrant

ELC.md

-182
This file was deleted.

docs/about/release_notes.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ Working with releases
2525

2626
The following PyPI commands are useful for working with different version of DroneKit Python: ::
2727

28-
pip install droneapi # Install the latest version
29-
pip install droneapi --upgrade # Update to the latest version
30-
pip show droneapi # Find out what release you have installed
31-
pip install droneapi=1.0.3 # Get a sepcific old release (in this case 1.0.3
28+
pip install dronekit # Install the latest version
29+
pip install dronekit --upgrade # Update to the latest version
30+
pip show dronekit # Find out what release you have installed
31+
pip install dronekit=1.0.3 # Get a sepcific old release (in this case 1.0.3
3232
33-
See `Release History on the package ranking page <http://pypi-ranking.info/module/droneapi#release_history>`_ for a list of all releases available on PyPI.
33+
See `Release History on the package ranking page <http://pypi-ranking.info/module/dronekit#release_history>`_ for a list of all releases available on PyPI.
3434

docs/automodule.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ DroneKit-Python API Reference
55
=============================
66

77

8-
.. automodule:: droneapi.lib
8+
.. automodule:: dronekit.lib
99
:members:
1010
:inherited-members:
1111
:exclude-members: Mission, get_mission, ConnectionInfo, web_connect, AuthInfo, delete

docs/contributing/developer_setup_windows.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The steps to install this package and the most important add-on modules are:
3939
.. code:: bash
4040
4141
pip uninstall python-dateutil
42-
pip install droneapi
42+
pip install dronekit
4343

4444
The dependencies above are all that are required to build DroneKit-Python and the *MAVProxy command line* (i.e. the minimum needed for testing).
4545
If you also want the *MAVProxy console* and map install:

docs/examples/drone_delivery.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Looking at the code
5252
Using attribute observers
5353
-------------------------
5454

55-
All attributes in DroneKit can have observers - this is the primary mechanism you should use to be notified of changes in vehicle state. For instance, `drone_delivery.py <https://github.com/diydrones/droneapi-python/blob/master/examples/drone_delivery/drone_delivery.py>`_ calls:
55+
All attributes in DroneKit can have observers - this is the primary mechanism you should use to be notified of changes in vehicle state. For instance, `drone_delivery.py <https://github.com/dronekit/dronekit-python/blob/master/examples/drone_delivery/drone_delivery.py>`_ calls:
5656

5757
::
5858

docs/examples/follow_me.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Before running this demo you'll need to make sure your computer has the gpsd ser
1818
1919
apt-get install gpsd gpsd-clients
2020
21-
You can then plug in a USB GPS and run the "xgps" client to confirm that it is working. If you do not have a USB GPS you can use simulated data by running *droneapi-python/examples/run-fake-gps.sh*.
21+
You can then plug in a USB GPS and run the "xgps" client to confirm that it is working. If you do not have a USB GPS you can use simulated data by running *dronekit-python/examples/run-fake-gps.sh*.
2222

2323
Once your GPS is plugged in you can start follow-me by running the following command inside of MAVProxy:
2424

docs/examples/mission_basic.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -123,11 +123,11 @@ After taking off (in guided mode using the ``takeoff()`` function) the example s
123123
The progress of the mission is monitored in a loop. The convenience function
124124
:ref:`distance_to_current_waypoint() <auto_mode_mission_distance_to_waypoint>`
125125
gets the distance to the next waypoint and
126-
:py:func:`Vehicle.commands.next <droneapi.lib.CommandSequence.next>` gets the value of
126+
:py:func:`Vehicle.commands.next <dronekit.lib.CommandSequence.next>` gets the value of
127127
the next command.
128128

129129
We also show how to move to a specified command using
130-
:py:func:`Vehicle.commands.next <droneapi.lib.CommandSequence.next>` (note how we skip the third command below):
130+
:py:func:`Vehicle.commands.next <dronekit.lib.CommandSequence.next>` (note how we skip the third command below):
131131

132132
.. code:: python
133133

docs/examples/running_examples.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ provided in the documentation for each example):
1212

1313
.. code-block:: bash
1414
15-
git clone http://github.com/dronekit/droneapi-python.git
15+
git clone http://github.com/dronekit/dronekit-python.git
1616
1717
.. tip::
1818

@@ -38,7 +38,7 @@ provided in the documentation for each example):
3838

3939
.. code-block:: bash
4040
41-
module load droneapi.module.api
41+
module load dronekit.module.api
4242
4343
#. Once the *MAVProxy* console is running, start the example by entering:
4444

docs/examples/simple_goto.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Example: Simple Go To (Copter)
55
==============================
66

77
This example demonstrates how to arm and launch a Copter in GUIDED mode, travel to a number of waypoints, and then return
8-
to the home location. It uses :py:func:`Vehicle.commands.takeoff() <droneapi.lib.CommandSequence.takeoff>`,
9-
:py:func:`Vehicle.commands.goto() <droneapi.lib.CommandSequence.goto>` and :py:attr:`Vehicle.mode <droneapi.lib.Vehicle.mode>`.
8+
to the home location. It uses :py:func:`Vehicle.commands.takeoff() <dronekit.lib.CommandSequence.takeoff>`,
9+
:py:func:`Vehicle.commands.goto() <dronekit.lib.CommandSequence.goto>` and :py:attr:`Vehicle.mode <dronekit.lib.Vehicle.mode>`.
1010

1111
The locations used are centred around the home location when the :ref:`Simulated Vehicle <vagrant-sitl-from-full-image>` is booted; you can edit the latitude and longitude
1212
to use more appropriate positions for your own vehicle.
@@ -95,16 +95,16 @@ Takeoff
9595
-------
9696
9797
To launch *Copter* you need to set the mode to ``GUIDED``, arm the vehicle, and then call
98-
:py:func:`Vehicle.commands.takeoff() <droneapi.lib.CommandSequence.takeoff>`. The takeoff code in this example
98+
:py:func:`Vehicle.commands.takeoff() <dronekit.lib.CommandSequence.takeoff>`. The takeoff code in this example
9999
is explained in the guide topic :ref:`taking-off`.
100100
101101
102102
Flying to a point - Goto
103103
------------------------
104104
105105
The vehicle is already in ``GUIDED`` mode, so to send it to a certain point we just need to
106-
call :py:func:`Vehicle.commands.goto() <droneapi.lib.CommandSequence.goto>` with the target location,
107-
and then :py:func:`flush() <droneapi.lib.Vehicle.flush>` the command:
106+
call :py:func:`Vehicle.commands.goto() <dronekit.lib.CommandSequence.goto>` with the target location,
107+
and then :py:func:`flush() <dronekit.lib.Vehicle.flush>` the command:
108108
109109
.. code-block:: python
110110

docs/examples/vehicle_state.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The vehicle and DroneKit should be set up as described in :ref:`get-started`.
1818

1919
If you're using a simulated vehicle remember to :ref:`disable arming checks <disable-arming-checks>` so
2020
that the example can run. You can also `add a virtual rangefinder <http://dev.ardupilot.com/wiki/simulation-2/sitl-simulator-software-in-the-loop/using-sitl-for-ardupilot-testing/#adding_a_virtual_rangefinder>`_
21-
(otherwise the :py:attr:`Vehicle.rangefinder <droneapi.lib.Vehicle.rangefinder>` attribute may return values of ``None`` for the distance
21+
(otherwise the :py:attr:`Vehicle.rangefinder <dronekit.lib.Vehicle.rangefinder>` attribute may return values of ``None`` for the distance
2222
and voltage).
2323

2424
Once MAVProxy is running and the API is loaded, you can start the example by typing: ``api start vehicle_state.py``.

0 commit comments

Comments
 (0)