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

Commit 6685a0f

Browse files
SethMichaelLarsonSethMichaelLarson
authored
Merge pull request #72 from SethMichaelLarson/move-changelog
Move CHANGES.rst to project root
2 parents faf3ed9 + 1041e6a commit 6685a0f

7 files changed

Lines changed: 139 additions & 117 deletions

File tree

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ instance/
6262

6363
# Sphinx documentation
6464
docs/_build/
65+
docs/build/
6566

6667
# PyBuilder
6768
target/

‎CHANGES.rst‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
Changelog
2+
=========
3+
4+
master
5+
6+
* IGuest.create_session() now raises a more descriptive error if
7+
not able to connect with a zero-length password. (@SethMichaelLarson PR #70)
8+
* Add sys.executable-derived paths in list to check for vboxapi (@SethMichaelLarson PR #69)
9+
* Fix IGuestProcess.execute() on Python 3.x (@SethMichaelLarson PR #58)
10+
* Fix errors to not output on Windows platforms. (@SethMichaelLarson PR #57)
11+
12+
version 1.0.0
13+
14+
* Support for 5.0.x VirtualBox.
15+
* Introduce Major.Minor virtualbox build version assertion when creating a VirtualBox
16+
instance.
17+
* Fix to IMachine.export_to (contribution from @z00m1n).
18+
19+
version 0.2.2
20+
21+
* Cleanup managers at exit (reported by @jiml521).
22+
* Add three time check for attribute in xpcom interface object before failing (reported
23+
by @shohamp).
24+
* Update library.py to 4.3.28/src/VBox/Main/idl/VirtualBox.xidl
25+
26+
version 0.2.0
27+
28+
* This change introduces some significant (potential compatability breaking)
29+
updates from the latest VirtualBox.xidl.
30+
* Bug fixes in IMachine (reported by @danikdanik).
31+
* IHost API issue workaround by @wndhydrnt.
32+
33+
version 0.1.6
34+
35+
* Bug fixes (compatability issue with py26 and virtual keyboard).
36+
* Thanks to contributions by @D4rkC4t and @Guilherme Moro.
37+
38+
version 0.1.5
39+
40+
* Improve error handling and documentation of error types.
41+
* Appliance extension.
42+
* Update to latest API (includes Paravirt provider).
43+
* Thanks to contributions by @nilp0inter
44+
45+
version 0.1.4 (09/04/2014)
46+
47+
* Fixed bug in error class container.
48+
49+
version 0.1.3 (04/03/2014)
50+
51+
* Bug fix for API support.
52+
* Added markup generation to library documentation.
53+
* Improved Manager bootstrap design.
54+
* Py3 compatibility (although vboxapi does not support py3).
55+
56+
version 0.1.2 (28/02/2014)
57+
58+
* Bug fix for virtualenv support
59+
* `Keyboard scancode decoder`_ (Note: coded in the delivery suite on the day of
60+
the birth of my baby girl Sophia.)
61+
* Refactored documentation
62+
63+
version 0.1.1 (17/02/2014)
64+
65+
* Minor improvements
66+
* Additional extensions
67+
* virtualenv support
68+
69+
version 0.1 (05/01/2014)
70+
71+
* As per roadmap v0.1
72+
* type checking baseinteger
73+
* update to latests Xidl
74+
75+
version 0.0.7 (09/10/2013)
76+
77+
* `machine pool`_
78+
79+
version 0.0.6 (25/07/2013)
80+
81+
* now with `event support`_
82+
83+
version 0.0.5 (23/07/2013)
84+
85+
* moved manage into library_ext Interfaces
86+
* made library.py compatible with differences found between xpcom and COM
87+
(Linux Vs Windows)
88+
89+
version 0.0.4 (27/06/2013)
90+
91+
* added execute, context, and keyboard
92+
93+
version 0.0.3 (30/05/2012)
94+
95+
* added manage
96+
97+
version 0.0.2 (28/05/2013)
98+
99+
* `library ext module`_
100+
101+
version 0.0.1 (27/05/2013)
102+
103+
* packaged
104+
105+
version 0.0.0 (20/05/2013)
106+
107+
* builder
108+
* library primitives
109+
110+
111+
.. _event support: http://pythonhosted.org//pyvbox/virtualbox/events.html
112+
.. _library ext module: http://pythonhosted.org/pyvbox/virtualbox/library_ext.html
113+
.. _machine pool: http://pythonhosted.org/pyvbox/virtualbox/pool.html
114+
.. _Keyboard scancode decoder: https://gist.github.com/mjdorma/9132605

‎build_docs.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import os
2+
import shutil
3+
4+
base_dir = os.path.dirname(os.path.abspath(__file__))
5+
build_dir = os.path.join(base_dir, 'docs', 'build')
6+
if os.path.isdir(build_dir):
7+
shutil.rmtree(build_dir)
8+
9+
os.chdir(os.path.join(base_dir, 'docs'))
10+
os.system('make html')

‎dev-requirements.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
tox==2.7.0
2+
flake8==3.3.0
3+
Sphinx==1.6.1

‎docs/source/changelog.rst‎

Lines changed: 1 addition & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -1,114 +1 @@
1-
Change log
2-
==========
3-
4-
master
5-
6-
* IGuest.create_session() now raises a more descriptive error if
7-
not able to connect with a zero-length password. (@SethMichaelLarson PR #70)
8-
* Add sys.executable-derived paths in list to check for vboxapi (@SethMichaelLarson PR #69)
9-
* Fix IGuestProcess.execute() on Python 3.x (@SethMichaelLarson PR #58)
10-
* Fix errors to not output on Windows platforms. (@SethMichaelLarson PR #57)
11-
12-
version 1.0.0
13-
14-
* Support for 5.0.x VirtualBox.
15-
* Introduce Major.Minor virtualbox build version assertion when creating a VirtualBox
16-
instance.
17-
* Fix to iMachine.export_to (contribution from @z00m1n).
18-
19-
version 0.2.2
20-
21-
* Cleanup managers at exit (reported by @jiml521).
22-
* Add three time check for attribute in xpcom interface object before failing (reported
23-
by @shohamp).
24-
* Update library.py to 4.3.28/src/VBox/Main/idl/VirtualBox.xidl
25-
26-
version 0.2.0
27-
28-
* This change introduces some significant (potential compatability breaking)
29-
updates from the latest VirtualBox.xidl.
30-
* Bug fixes in IMachine (reported by @danikdanik).
31-
* IHost API issue workaround by @wndhydrnt.
32-
33-
version 0.1.6
34-
35-
* Bug fixes (compatability issue with py26 and virtual keyboard).
36-
* Thanks to contributions by @D4rkC4t and @Guilherme Moro.
37-
38-
version 0.1.5
39-
40-
* Improve error handling and documentation of error types.
41-
* Appliance extension.
42-
* Update to latest API (includes Paravirt provider).
43-
* Thanks to contributions by @nilp0inter
44-
45-
version 0.1.4 (09/04/2014)
46-
47-
* Fixed bug in error class container.
48-
49-
version 0.1.3 (04/03/2014)
50-
51-
* Bug fix for API support.
52-
* Added markup generation to library documentation.
53-
* Improved Manager bootstrap design.
54-
* Py3 compatibility (although vboxapi does not support py3).
55-
56-
version 0.1.2 (28/02/2014)
57-
58-
* Bug fix for virtualenv support
59-
* `Keyboard scancode decoder`_ (Note: coded in the delivery suite on the day of
60-
the birth of my baby girl Sophia.)
61-
* Refactored documentation
62-
63-
version 0.1.1 (17/02/2014)
64-
65-
* Minor improvements
66-
* Additional extensions
67-
* virtualenv support
68-
69-
version 0.1 (05/01/2014)
70-
71-
* As per roadmap v0.1
72-
* type checking baseinteger
73-
* update to latests Xidl
74-
75-
version 0.0.7 (09/10/2013)
76-
77-
* `machine pool`_
78-
79-
version 0.0.6 (25/07/2013)
80-
81-
* now with `event support`_
82-
83-
version 0.0.5 (23/07/2013)
84-
85-
* moved manage into library_ext Interfaces
86-
* made library.py compatible with differences found between xpcom and COM
87-
(Linux Vs Windows)
88-
89-
version 0.0.4 (27/06/2013)
90-
91-
* added execute, context, and keyboard
92-
93-
version 0.0.3 (30/05/2012)
94-
95-
* added manage
96-
97-
version 0.0.2 (28/05/2013)
98-
99-
* `library ext module`_
100-
101-
version 0.0.1 (27/05/2013)
102-
103-
* packaged
104-
105-
version 0.0.0 (20/05/2013)
106-
107-
* builder
108-
* library primitives
109-
110-
111-
.. _event support: http://pythonhosted.org//pyvbox/virtualbox/events.html
112-
.. _library ext module: http://pythonhosted.org/pyvbox/virtualbox/library_ext.html
113-
.. _machine pool: http://pythonhosted.org/pyvbox/virtualbox/pool.html
114-
.. _Keyboard scancode decoder: https://gist.github.com/mjdorma/9132605
1+
.. include:: ../../CHANGES.rst

‎setup.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,19 @@
1111

1212
tests_require = ['begins', 'funconf']
1313

14+
1415
def load_version(filename='./virtualbox/version.py'):
1516
"""Parse a __version__ number from a source file"""
1617
with open(filename) as source:
1718
text = source.read()
1819
match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", text)
1920
if not match:
2021
msg = "Unable to find version number in {}".format(filename)
21-
raise RuntimeError( msg)
22+
raise RuntimeError(msg)
2223
version = match.group(1)
2324
return version
2425

26+
2527
setup(
2628
name="pyvbox",
2729
version=load_version(),
@@ -34,7 +36,7 @@ def load_version(filename='./virtualbox/version.py'):
3436
long_description=open('README.rst').read(),
3537
license="Apache-2.0",
3638
zip_safe=False,
37-
install_requires = install_requires,
39+
install_requires=install_requires,
3840
platforms=['cygwin', 'win', 'linux'],
3941
classifiers=[
4042
'Development Status :: 5 - Production/Stable',

‎tox.ini‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
[tox]
2-
envlist = lint
2+
envlist = lint docs
33

44
[testenv:lint]
55
commands =
66
python -m pip install flake8
77
flake8 virtualbox/
8+
9+
[testenv:docs]
10+
commands =
11+
python -m pip install --upgrade -r dev-requirements.txt
12+
python {toxinidir}/build_docs.py

0 commit comments

Comments
 (0)