Metadata-Version: 2.4
Name: pioneer-sdk
Version: 0.6.1
Summary: Programming tools for Geoscan Pioneer drone
Author-email: Geoscan <info@geoscan.aero>
License: MIT License
        Copyright (c) 2018 geoscan
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://gitflic.ru/project/geoscan-llc/pioneer-sdk
Project-URL: Documentation, https://docs.geoscan.ru/pioneer/
Keywords: mavlink,pioneer,geoscan,uav
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: <3.13,>=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: future==0.18.3
Requires-Dist: lxml==5.3.1
Requires-Dist: numpy<=1.26.4
Requires-Dist: opencv-python==4.11.0.86
Requires-Dist: pymavlink==2.4.37
Requires-Dist: pyserial==3.5
Dynamic: license-file

# Geoscan `pioneer_sdk`

Geoscan PioneerSDK is a collection of tools for interfacing with Geoscan Pioneer UAVs.  
It provides a succinct and convenient API to drones' functions such as autonomous flight, acquiring frames from a drone's camera, and more.  
Please feel free to explore the `examples/` directory for stepping stones and inspiration.

## Installation

You can install the SDK in several ways:

### 1. From PyPI (latest release)

```bash
python3 -m pip install pioneer-sdk
````

### 2. From GitFlic (main branch)

```bash
python3 -m pip install "pioneer-sdk @ git+https://gitflic.ru/project/geoscan-llc/pioneer-sdk.git@master"
```

## Usage

```python
from pioneer_sdk import Pioneer

pioneer_mini = Pioneer()

if __name__ == '__main__':
    ...
```

## Documentation

You can read more information about the package in the documentation:
[readthedocs](https://pioneer-doc.readthedocs.io/ru/master/programming/python/python_main.html)

## Additional information

You can find the examples and the camera calibration script in the corresponding folders.
Unlike the "bare" `pioneer_sdk`, they require a broader set of dependencies.
To satisfy the requirements, run:

```bash
python3 -m pip install -r requirements.txt
```
