Skip to content
This repository was archived by the owner on Feb 6, 2024. It is now read-only.

Commit 27ddf90

Browse files
tcr3drtcr3dr
committed
2.0.0
1 parent 2830462 commit 27ddf90

File tree

6 files changed

+141
-160
lines changed

6 files changed

+141
-160
lines changed

‎CHANGELOG.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Changelog
2+
3+
## Version 2.0.0 (2015-11-23)
4+
5+
### New Features:
6+
7+
* Renamed library and package from DroneAPI to DroneKit on pip
8+
* DroneKit Python is now a standalone library and no longer requires use of MAVProxy
9+
* Connect multiple vehicles in one script by creating separate vehicle instances
10+
* Removed NumPy, ProtoBuf as dependencies
11+
* Add MAVLink message listeners using `add_message_listener` methods
12+
* Added `on_attribute` and `on_message` function decorator shorthands
13+
* Added `mount_status`, `system_status`, `ekf_ok`, `is_armable`, `heading`
14+
* Made settable `groundspeed`, `airspeed`
15+
* Moved `dronekit.lib` entries to root package `dronekit`
16+
* Added `parameters.set` and `parameters.get` for fine-tuned parameter access
17+
* `parameters` now observable and iterable (#442)
18+
* Added `last_heartbeat` attribute, updated every event loop with time since last heartbeat (#451)
19+
* Await attributes through `wait_ready` method and `connect` method parameter
20+
* Adds subclassable Vehicle class, used by `vehicle_class` parameter in `connect`
21+
22+
### Updated Features:
23+
24+
* local_connect renamed to connect(), accepting a connection path, link configuration, and timeout settings
25+
* Removed `.set_mavrx_callback`. Use `vehicle.on_message('*', obj)` methods
26+
* Renamed `add_attribute_observer` methods to `add_attribute_listener`, etc. (#420)
27+
* Renamed `wait_init` and `wait_valid` to `wait_ready`
28+
* Split `home_location` is a separate attribute from `commands` waypoint array
29+
* Moved RC channels into `.channels` object (#427)
30+
* Split location information into `local_frame`, `global_frame`, and `global_relative_frame` (and removed `is_relative`) (#445)
31+
* Renamed `flush` to `commands.upload`, as it only impacts waypoints (#276)
32+
* `commands.goto` and `commands.takeoff` renamed to `simple_goto` and `simple_takeoff`
33+
34+
### Bug Fixes:
35+
36+
* `armed` and `mode` attributes updated constantly (#60, #446)
37+
* Parameter setting times out (#12)
38+
* `battery` access can throw exception (#298)
39+
* Vehicle.location reports incorrect is_relative value for Copter (#130)
40+
* Excess arming message when already armed

‎docs/about/github_latest_release.txt

+61-28
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,63 @@
11
.. This document was auto-generated by the get_release_notes.py script using latest-release information from github
22

3-
Release 1.5.0 (August 12, 2015)
4-
===============================
5-
6-
7-
**Features:**
8-
9-
* Added methods to unset `mavlink_callback`. (#115, #240)
10-
* Publishing scripts now live in `scripts/` (#259)
11-
12-
**Documentation:**
13-
14-
* Documented clearing of `mavlink_callback`. (#245)
15-
16-
Source Code
17-
-----------
18-
19-
20-
Source code is available `here <https://github.com/dronekit/dronekit-python/releases/tag/v1.5.0>`_.
21-
22-
* View `**commits** included in this release <https://github.com/dronekit/dronekit-python/compare/v1.4.3...v1.5.0>`_
23-
* View `**bugs** closed by this release <https://github.com/dronekit/dronekit-python/issues?utf8=%E2%9C%93&q=is%3Aclosed+created%3A%3E2015-08-10+is%3Aissue+>`_
24-
* View `**pull requests** merged into this release <https://github.com/dronekit/dronekit-python/pulls?utf8=%E2%9C%93&q=is%3Amerged+created%3A%3E2015-08-10+is%3Apr+>`_
25-
26-
Notes
27-
-----
28-
29-
30-
Thanks to @hamishwillee, @mrpollo, @tcr3dr
3+
Changelog
4+
=========
5+
6+
Version 2.0.0 (2015-11-23)
7+
--------------------------
8+
9+
New Features:
10+
~~~~~~~~~~~~~
11+
12+
- Renamed library and package from DroneAPI to DroneKit on pip
13+
- DroneKit Python is now a standalone library and no longer requires
14+
use of MAVProxy
15+
- Connect multiple vehicles in one script by creating separate vehicle
16+
instances
17+
- Removed NumPy, ProtoBuf as dependencies
18+
- Add MAVLink message listeners using ``add_message_listener`` methods
19+
- Added ``on_attribute`` and ``on_message`` function decorator
20+
shorthands
21+
- Added ``mount_status``, ``system_status``, ``ekf_ok``,
22+
``is_armable``, ``heading``
23+
- Made settable ``groundspeed``, ``airspeed``
24+
- Moved ``dronekit.lib`` entries to root package ``dronekit``
25+
- Added ``parameters.set`` and ``parameters.get`` for fine-tuned
26+
parameter access
27+
- ``parameters`` now observable and iterable (`#442 <https://github.com/dronekit/dronekit-python/pulls/#44>`_)
28+
- Added ``last_heartbeat`` attribute, updated every event loop with
29+
time since last heartbeat (`#451 <https://github.com/dronekit/dronekit-python/pulls/#45>`_)
30+
- Await attributes through ``wait_ready`` method and ``connect`` method
31+
parameter
32+
- Adds subclassable Vehicle class, used by ``vehicle_class`` parameter
33+
in ``connect``
34+
35+
Updated Features:
36+
~~~~~~~~~~~~~~~~~
37+
38+
- local\_connect renamed to connect(), accepting a connection path,
39+
link configuration, and timeout settings
40+
- Removed ``.set_mavrx_callback``. Use ``vehicle.on_message('*', obj)``
41+
methods
42+
- Renamed ``add_attribute_observer`` methods to
43+
``add_attribute_listener``, etc. (`#420 <https://github.com/dronekit/dronekit-python/pulls/#42>`_)
44+
- Renamed ``wait_init`` and ``wait_valid`` to ``wait_ready``
45+
- Split ``home_location`` is a separate attribute from ``commands``
46+
waypoint array
47+
- Moved RC channels into ``.channels`` object (`#427 <https://github.com/dronekit/dronekit-python/pulls/#42>`_)
48+
- Split location information into ``local_frame``, ``global_frame``,
49+
and ``global_relative_frame`` (and removed ``is_relative``) (`#445 <https://github.com/dronekit/dronekit-python/pulls/#44>`_)
50+
- Renamed ``flush`` to ``commands.upload``, as it only impacts
51+
waypoints (`#276 <https://github.com/dronekit/dronekit-python/pulls/#27>`_)
52+
- ``commands.goto`` and ``commands.takeoff`` renamed to ``simple_goto``
53+
and ``simple_takeoff``
54+
55+
Bug Fixes:
56+
~~~~~~~~~~
57+
58+
- ``armed`` and ``mode`` attributes updated constantly (`#60 <https://github.com/dronekit/dronekit-python/pulls/#6>`_, `#446 <https://github.com/dronekit/dronekit-python/pulls/#44>`_)
59+
- Parameter setting times out (`#12 <https://github.com/dronekit/dronekit-python/pulls/#1>`_)
60+
- ``battery`` access can throw exception (`#298 <https://github.com/dronekit/dronekit-python/pulls/#29>`_)
61+
- Vehicle.location reports incorrect is\_relative value for Copter
62+
(`#130 <https://github.com/dronekit/dronekit-python/pulls/#13>`_)
63+
- Excess arming message when already armed

‎scripts/get_release_notes.py

-110
This file was deleted.

‎scripts/update-docs.sh

+1-20
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,3 @@
11
#!/bin/bash
22

3-
cd $(dirname $0)
4-
cd ..
5-
6-
rm -r /tmp/autodocs
7-
set -e
8-
python ./setup.py build
9-
echo Switching to doc tree
10-
cd docs
11-
make html
12-
cp -a _build/html /tmp/autodocs
13-
cd ..
14-
git checkout gh-pages
15-
cp -a /tmp/autodocs/* .
16-
set +e
17-
find . | xargs git add
18-
set -e
19-
git commit -m "Update docs"
20-
git push
21-
git checkout -f master
22-
3+
ssh dronekit.io "./update_python.sh"

‎scripts/update-releasenotes.sh

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
#!/usr/bin/env python
2+
3+
"""
4+
This script gets the release notes, converts it from markdown to
5+
reStructured Text format, and writes it to a text file.
6+
7+
The text file can be auto-imported by Sphinx into the official release notes.
8+
"""
9+
10+
import os
11+
from pypandoc import convert
12+
from optparse import OptionParser
13+
import re
14+
15+
curpath = os.path.realpath(os.path.dirname(__file__))
16+
17+
#parser options
18+
parser = OptionParser(version="%prog 1.0.0", usage="Usage: %prog [options] version")
19+
parser.add_option("-i" , "--input", dest="input", default=os.path.join(curpath, "../CHANGELOG.md"), help="Input file")
20+
parser.add_option("-f" , "--file", dest="file", default=os.path.join(curpath, "../docs/about/github_latest_release.txt"), help="Output file")
21+
22+
(options, args) = parser.parse_args()
23+
24+
rst_content = convert(options.input, 'rst')
25+
26+
# Hyperlink Github issues
27+
rst_content = re.sub(r'#\d+', lambda m: '`' + m.group() + ' <https://github.com/dronekit/dronekit-python/pulls/' + m.group()[:-1] + '>`_', rst_content)
28+
29+
# Prefix with some documentation
30+
rst_content = ".. This document was auto-generated by the get_release_notes.py script using latest-release information from github \n\n" + rst_content
31+
32+
release_notes_file = open(options.file,'w')
33+
release_notes_file.write(rst_content)
34+
release_notes_file.close()
35+
36+
print 'complete.'
37+

‎setup.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from setuptools import setup, Extension
22
import platform
33

4-
version = '2.0.0rc13'
4+
version = '2.0.0'
55

66
setup(name='dronekit',
77
zip_safe=True,
@@ -16,7 +16,7 @@
1616
],
1717
author_email='[email protected], [email protected]',
1818
classifiers=[
19-
'Development Status :: 4 - Beta',
19+
'Development Status :: 5 - Production/Stable',
2020
'Environment :: Console',
2121
'Intended Audience :: Science/Research',
2222
'License :: OSI Approved :: Apache Software License',

0 commit comments

Comments
 (0)