Skybrush Server is the server component behind the Skybrush ecosystem; it handles communication channels to drones and provides an abstraction layer on top of them so frontend apps (like Skybrush Live) do not need to know what type of drones they are communicating with.
The server also provides additional facilities like clocks, RTK correction
sources, weather providers and so on. It is extensible via extension modules
that can be loaded automatically at startup or dynamically while the server is
running. In fact, most of the functionality in the server is implemented in the
form of extensions; see the flockwave.server.ext module in the source code
for the list of built-in extensions. You may also develop your own extensions to
extend the functionality of the server.
-
Install
uv.uvwill manage a virtual environment for this project to keep things nicely separated. You won't pollute the system Python with the dependencies of the Skybrush server and everyone will be happier. See https://docs.astral.sh/uv/ for installation instructions. -
Check out the source code of the server.
-
Run
uv syncto install all the dependencies and the server itself in a separate virtualenv. The virtualenv will be created in a folder named.venvin the project folder. -
Run
uv run skybrushdto start the server.
This project contains both public and private dependencies in pyproject.toml.
Public dependencies are either on PyPI or in our public PyPI index at
Gemfury. Private dependencies hosted in our private
PyPI index are not required to build the community version of Skybrush Server.
However, if you are working with the project on your own and make any changes to
pyproject.toml that would necessitate the regeneration of the lockfile of
uv (i.e. uv.lock), uv itself may attempt to connect to our private package
index as it needs information about all dependencies to generate a consistent
lockfile. In this case, you should remove all the dependencies from
pyproject.toml that are pinned to the collmot package index -- these are
the ones in the pro or collmot extras.
Skybrush Server is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Skybrush Server is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.