rename to mavsdk

JonasVautherin · JonasVautherin · commit 684da83f7367 · 2019-06-18T00:23:24.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -11,4 +11,4 @@ build/
 *.ropeproject/
 .pytest_cache/
 .tox/
-dronecode_sdk/plugins/
+mavsdk/plugins/
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,2 +1,2 @@
-include dronecode_sdk/bin
-include dronecode_sdk/bin/backend_bin
+include mavsdk/bin
+include mavsdk/bin/mavsdk_server
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-# DronecodeSDK-Python
+# MAVSDK-Python
 
-This is the Python wrapper for the Dronecode SDK.
+This is the Python wrapper for MAVSDK.
 
-The Python wrapper is based on a gRPC client communicating with the gRPC server written in C++. To use the Python wrapper the gRPC server called "backend" needs to be running on the same system. The wrapper is essentially auto-generated from the message definitions ([proto files](https://github.com/Dronecode/DronecodeSDK-Proto)).
+The Python wrapper is based on a gRPC client communicating with the gRPC server written in C++. To use the Python wrapper the gRPC server called "backend" needs to be running on the same system. The wrapper is essentially auto-generated from the message definitions ([proto files](https://github.com/mavlink/MAVSDK-Proto)).
 
 ## Important Notes
 
@@ -16,8 +16,8 @@ First, we need to build and run the backend which is the gRPC server that the Py
 **Note: it is planned to automate this step using package managers like brew, apt-get, etc. .**
 
 ```
-git clone https://github.com/Dronecode/DronecodeSDK --recursive
-cd DronecodeSDK
+git clone https://github.com/mavlink/MAVSDK --recursive
+cd MAVSDK
 mkdir -p build/default
 cd build/default
 cmake -DBUILD_BACKEND=ON ../..
@@ -39,8 +39,8 @@ By default, the backend will connect using MAVLink on UDP port 14540 which is ru
 Clone this repo and recursively update submodules:
 
 ```
-git clone https://github.com/Dronecode/DronecodeSDK-Python --recursive
-cd DronecodeSDK-Python
+git clone https://github.com/mavlink/MAVSDK-Python --recursive
+cd MAVSDK-Python
 ```
 
 ### Install prerequisites
diff --git a/docs/TODO.md b/docs/TODO.md
diff --git a/dronecode_sdk/bin/README.md b/dronecode_sdk/bin/README.md
diff --git a/examples/calibration.py b/examples/calibration.py
@@ -2,9 +2,9 @@
 
 import asyncio
 
-from dronecode_sdk import connect as dronecode_sdk_connect
+from mavsdk import connect as mavsdk_connect
 
-drone = dronecode_sdk_connect(host="127.0.0.1")
+drone = mavsdk_connect(host="127.0.0.1")
 
 
 async def run():
diff --git a/examples/camera.py b/examples/camera.py
@@ -2,10 +2,10 @@
 
 import asyncio
 
-from dronecode_sdk import connect as dronecode_sdk_connect
-from dronecode_sdk import (CameraError, CameraMode)
+from mavsdk import connect as mavsdk_connect
+from mavsdk import (CameraError, CameraMode)
 
-drone = dronecode_sdk_connect(host="127.0.0.1")
+drone = mavsdk_connect(host="127.0.0.1")
 
 
 async def run():
diff --git a/examples/firmware_version.py b/examples/firmware_version.py
@@ -2,9 +2,9 @@
 
 import asyncio
 
-from dronecode_sdk import connect as dronecode_sdk_connect
+from mavsdk import connect as mavsdk_connect
 
-drone = dronecode_sdk_connect(host="127.0.0.1")
+drone = mavsdk_connect(host="127.0.0.1")
 
 
 async def run():
diff --git a/examples/mission.py b/examples/mission.py
@@ -2,10 +2,10 @@
 
 import asyncio
 
-from dronecode_sdk import connect as dronecode_sdk_connect
-from dronecode_sdk import (MissionItem)
+from mavsdk import connect as mavsdk_connect
+from mavsdk import (MissionItem)
 
-drone = dronecode_sdk_connect(host="127.0.0.1")
+drone = mavsdk_connect(host="127.0.0.1")
 
 
 async def run():
diff --git a/examples/offboard.py b/examples/offboard.py
@@ -6,24 +6,24 @@
 - `drone.action.arm()` will return a `COMMAND_DENIED` result because the action requires switching
   to LOITER mode first, something that is currently not supported in a non-gps environment. You will
   need to temporarily disable this part here:
-  `https://github.com/Dronecode/DronecodeSDK/blob/develop/plugins/action/action_impl.cpp#L61-L65`
+  `https://github.com/mavlink/MAVSDK/blob/develop/plugins/action/action_impl.cpp#L61-L65`
 
 - `drone.offboard.stop()` will also return a `COMMAND_DENIED` result because it requires a mode
   switch to HOLD, something that is currently not supported in a non-gps environment.
 """
 
 import asyncio
 
-from dronecode_sdk import connect as dronecode_sdk_connect
-from dronecode_sdk import (
+from mavsdk import connect as mavsdk_connect
+from mavsdk import (
     Attitude,
     OffboardError,
     PositionNEDYaw,
     VelocityBodyYawspeed,
     VelocityNEDYaw,
 )
 
-drone = dronecode_sdk_connect(host="127.0.0.1")
+drone = mavsdk_connect(host="127.0.0.1")
 
 
 async def run_offb_ctrl_velocity_ned():
diff --git a/examples/takeoff_and_land.py b/examples/takeoff_and_land.py
@@ -2,9 +2,9 @@
 
 import asyncio
 
-from dronecode_sdk import connect as dronecode_sdk_connect
+from mavsdk import connect as mavsdk_connect
 
-drone = dronecode_sdk_connect(host="127.0.0.1")
+drone = mavsdk_connect(host="127.0.0.1")
 
 
 async def run():
diff --git a/examples/telemetry.py b/examples/telemetry.py
@@ -2,9 +2,9 @@
 
 import asyncio
 
-from dronecode_sdk import connect as dronecode_sdk_connect
+from mavsdk import connect as mavsdk_connect
 
-drone = dronecode_sdk_connect(host="127.0.0.1")
+drone = mavsdk_connect(host="127.0.0.1")
 
 
 async def print_battery():
diff --git a/examples/telemetry_flight_mode.py b/examples/telemetry_flight_mode.py
@@ -2,9 +2,9 @@
 
 import asyncio
 
-from dronecode_sdk import connect as dronecode_sdk_connect
+from mavsdk import connect as mavsdk_connect
 
-drone = dronecode_sdk_connect(host="127.0.0.1")
+drone = mavsdk_connect(host="127.0.0.1")
 
 
 async def print_flight_mode():
diff --git a/examples/telemetry_is_armed_is_in_air.py b/examples/telemetry_is_armed_is_in_air.py
@@ -2,9 +2,9 @@
 
 import asyncio
 
-from dronecode_sdk import connect as dronecode_sdk_connect
+from mavsdk import connect as mavsdk_connect
 
-drone = dronecode_sdk_connect(host="127.0.0.1")
+drone = mavsdk_connect(host="127.0.0.1")
 
 
 async def print_is_armed():
diff --git a/examples/telemetry_takeoff_and_land.py b/examples/telemetry_takeoff_and_land.py
@@ -2,9 +2,9 @@
 
 import asyncio
 
-from dronecode_sdk import connect as dronecode_sdk_connect
+from mavsdk import connect as mavsdk_connect
 
-drone = dronecode_sdk_connect(host="127.0.0.1")
+drone = mavsdk_connect(host="127.0.0.1")
 
 async def run():
     """ Arms the system, initiates a takeof and finally lands the system """
diff --git a/mavsdk/__init__.py b/mavsdk/__init__.py
@@ -8,7 +8,7 @@
 import sys
 import time
 
-from dronecode_sdk import bin
+from mavsdk import bin
 
 # List of the core plugins
 CORE_PLUGINS = [
@@ -25,7 +25,7 @@
 
 # Check for compatibility
 if float(".".join(platform.python_version_tuple()[0:-1])) < 3.6:
-    print("[!] DronecodeSDK-Python is only available on Python >= 3.6")
+    print("[!] MAVSDK-Python is only available on Python >= 3.6")
     sys.exit(1)
 
 # Do asyncio specific initialization
@@ -72,7 +72,7 @@ def start_mavlink(connection_url=None):
     """
     Starts the gRPC server in a subprocess, listening on localhost:50051
     """
-    with path(bin, 'backend_bin') as backend:
+    with path(bin, 'mavsdk_server') as backend:
         bin_path_and_args = [os.fspath(backend)]
         if connection_url:
             bin_path_and_args.append(connection_url)
diff --git a/mavsdk/_base.py b/mavsdk/_base.py
diff --git a/mavsdk/async_plugin_manager.py b/mavsdk/async_plugin_manager.py
@@ -5,12 +5,12 @@
 
 class AsyncPluginManager:
     """
-    Connects to a running dronecore backend or starts one and manages plugins
+    Connects to a running mavsdk server or starts one and manages plugins
 
     :param host: IP address of host running the backend
     :param port: Port number
     :param secure: Use an SSL Layer (currently not supported)
-    :param loop: Event loop DronecodeSDK is running on
+    :param loop: Event loop MAVSDK is running on
 
     Initialize the plugin manager:
 
@@ -50,8 +50,7 @@ def _connect_backend(self):
         Initializes the connection to the running backend
         """
         if self.secure:
-            # For now just allow insecure connections in the development
-            # phase
+            # For now just allow insecure connections
             raise NotImplementedError()
 
         #: gRPC channel
diff --git a/mavsdk/bin/README.md b/mavsdk/bin/README.md
@@ -0,0 +1,3 @@
+It is expected that the grpc server binary `mavsdk_server` is present here when the wheel is built with:
+
+    python setup.py bdist_wheel
diff --git a/mavsdk/bin/__init__.py b/mavsdk/bin/__init__.py
diff --git a/mavsdk/generated/__init__.py b/mavsdk/generated/__init__.py
diff --git a/mavsdk/plugins/.gitkeep b/mavsdk/plugins/.gitkeep
diff --git a/other/templates/file.j2 b/other/templates/file.j2
@@ -31,7 +31,7 @@ class {{ plugin_name.upper_camel_case }}Error(Exception):
 {% endif %}
 
 class {{ plugin_name.upper_camel_case }}(AsyncBase):
-    """ Generated by dcsdkgen - DronecodeSDK {{ plugin_name.upper_camel_case }} API """
+    """ Generated by dcsdkgen - MAVSDK {{ plugin_name.upper_camel_case }} API """
 
     # Plugin name
     name = "{{ plugin_name.upper_camel_case }}"
diff --git a/other/tools/run_protoc.sh b/other/tools/run_protoc.sh
@@ -2,8 +2,8 @@
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 WORK_DIR="${SCRIPT_DIR}/../../"
 PROTO_DIR="${WORK_DIR}/proto"
-GENERATED_DIR="${WORK_DIR}/dronecode_sdk/generated"
-PLUGIN_DIR="${WORK_DIR}/dronecode_sdk/plugins"
+GENERATED_DIR="${WORK_DIR}/mavsdk/generated"
+PLUGIN_DIR="${WORK_DIR}/mavsdk/plugins"
 PLUGIN_INIT="${PLUGIN_DIR}/__init__.py"
 export TEMPLATE_PATH="${WORK_DIR}/other/templates/"
 
@@ -61,11 +61,11 @@ function install_dcsdkgen {
     then
         pip3 install .
     else
-        pip3  install --user .
+        pip3 install --user .
     fi
 }
 
-echo "[+] Installing the DronecodeSDK autogenerator"
+echo "[+] Installing the MAVSDK autogenerator"
 install_dcsdkgen
 echo "[+] Done"
 echo "[+] Generating plugins from "
diff --git a/other/tools/run_tests.sh b/other/tools/run_tests.sh
@@ -2,8 +2,8 @@
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 WORK_DIR="${SCRIPT_DIR}/../.."
 DOCKER_DIR="${WORK_DIR}/other/docker/testing/"
-DOCKER_IMAGE_NAME="tox-dronecode-sdk-python"
-DOCKER_BUILD_LOG_PATH="/tmp/dronecode-sdk-python-docker-build.log"
+DOCKER_IMAGE_NAME="tox-mavsdk-python"
+DOCKER_BUILD_LOG_PATH="/tmp/mavsdk-python-docker-build.log"
 
 function build_docker_image {
     cd $DOCKER_DIR
diff --git a/setup.py b/setup.py
@@ -36,11 +36,11 @@ def parse_long_description():
 
 
 setup(
-    name="dronecode-sdk",
+    name="mavsdk",
     version="0.1.0",
-    description="Python wrapper for Dronecode SDK",
+    description="Python wrapper for MAVSDK",
     long_description=parse_long_description(),
-    url="https://github.com/dronecode/DronecodeSDK-Python",
+    url="https://github.com/mavlink/MAVSDK-Python",
     maintainer="Jonas Vautherin, Julian Oes",
     maintainer_email="jonas@auterion.com, julian.oes@auterion.com",
     include_package_data=True,
@@ -58,7 +58,7 @@ def parse_long_description():
     setup_requires=parse_requirements("requirements-dev.txt"),
 
     project_urls={
-        "Bug Reports": "https://github.com/dronecode/DronecodeSDK-Python/issues",
-        "Source": "https://github.com/dronecode/DronecodeSDK-Python/",
+        "Bug Reports": "https://github.com/mavlink/MAVSDK-Python/issues",
+        "Source": "https://github.com/mavlink/MAVSDK-Python/",
     },
 )
