vbox-sdk 6.0.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- vbox_sdk-6.0.0.dist-info/METADATA +119 -0
- vbox_sdk-6.0.0.dist-info/RECORD +5 -0
- vbox_sdk-6.0.0.dist-info/WHEEL +4 -0
- vboxapi/VirtualBox_constants.py +3615 -0
- vboxapi/__init__.py +1252 -0
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: vbox-sdk
|
|
3
|
+
Version: 6.0.0
|
|
4
|
+
Summary: The VirtualBox Software Developer Kit's Python bindings, as available from https://www.virtualbox.org/wiki/Downloads
|
|
5
|
+
Keywords: vbox,vbox api,vbox sdk,VirtualBox,Oracle,virtual machine manager
|
|
6
|
+
Author: Oracle Corp.
|
|
7
|
+
Author-email: Oracle Corp. <help@oracle.com>
|
|
8
|
+
License-Expression: Unlicense
|
|
9
|
+
Classifier: Intended Audience :: Developers
|
|
10
|
+
Classifier: Operating System :: POSIX
|
|
11
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
12
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
13
|
+
Classifier: Operating System :: MacOS
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
19
|
+
Maintainer: Mike Mabey
|
|
20
|
+
Maintainer-email: Mike Mabey <mmabey@ieee.org>
|
|
21
|
+
Requires-Python: >=3.10
|
|
22
|
+
Project-URL: Homepage, https://github.com/mmabey/vbox_sdk
|
|
23
|
+
Project-URL: Source, https://github.com/mmabey/vbox_sdk/tree/pylibsonly
|
|
24
|
+
Project-URL: Releases, https://github.com/mmabey/vbox_sdk/releases
|
|
25
|
+
Description-Content-Type: text/x-rst
|
|
26
|
+
|
|
27
|
+
VirtualBox Software Developer Kit (SDK)
|
|
28
|
+
=======================================
|
|
29
|
+
|
|
30
|
+
.. image:: https://img.shields.io/pypi/v/vbox_sdk.svg
|
|
31
|
+
:target: https://pypi.python.org/pypi/vbox_sdk
|
|
32
|
+
|
|
33
|
+
.. image:: https://img.shields.io/pypi/pyversions/vbox_sdk.svg
|
|
34
|
+
:target: https://pypi.python.org/pypi/vbox_sdk
|
|
35
|
+
|
|
36
|
+
.. image:: https://img.shields.io/pypi/l/vbox_sdk.svg
|
|
37
|
+
:target: https://pypi.python.org/pypi/vbox_sdk
|
|
38
|
+
|
|
39
|
+
.. image:: https://img.shields.io/pypi/dm/vbox_sdk.svg
|
|
40
|
+
:target: https://pypi.python.org/pypi/vbox_sdk
|
|
41
|
+
|
|
42
|
+
Oracle provides this SDK to interface with VirtualBox. This branch contains
|
|
43
|
+
only the Python bindings (``vboxapi``) extracted from Oracle's SDK, packaged
|
|
44
|
+
for installation via pip. For the full SDK exactly as Oracle ships it, see the
|
|
45
|
+
``main`` branch instead.
|
|
46
|
+
|
|
47
|
+
A new release is published here automatically whenever Oracle publishes a new
|
|
48
|
+
VirtualBox SDK version; the package version always matches VirtualBox's own
|
|
49
|
+
version number (see ``pyproject.toml``).
|
|
50
|
+
|
|
51
|
+
The code is available on `Github`_ and `PyPI`_.
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
Installation
|
|
55
|
+
------------
|
|
56
|
+
|
|
57
|
+
Since the package is listed on `PyPI`_, you can install it with:
|
|
58
|
+
|
|
59
|
+
::
|
|
60
|
+
|
|
61
|
+
pip install vbox-sdk
|
|
62
|
+
|
|
63
|
+
Please note that this package conflicts with the ``vboxapi`` package.
|
|
64
|
+
|
|
65
|
+
If you need the bindings for a specific old VirtualBox version, pin that
|
|
66
|
+
version, e.g. ``pip install vbox-sdk==7.0.14``.
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
Usage
|
|
70
|
+
-----
|
|
71
|
+
|
|
72
|
+
I won't attempt to document the full API since I'm not the maintainer of the
|
|
73
|
+
actual code. However, if, like me, all you're trying to do is manage the VMs
|
|
74
|
+
in VirtualBox, you'll want to check out the ``vboxapi.VirtualBoxManager`` class
|
|
75
|
+
in particular. From the SDK Reference manual, here's an example of how to use
|
|
76
|
+
the manager to perform some basic tasks:
|
|
77
|
+
|
|
78
|
+
::
|
|
79
|
+
|
|
80
|
+
from vboxapi import VirtualBoxManager
|
|
81
|
+
mgr = VirtualBoxManager(None, None)
|
|
82
|
+
vbox = mgr.vbox
|
|
83
|
+
name = "Linux"
|
|
84
|
+
mach = vbox.findMachine(name)
|
|
85
|
+
session = mgr.getSessionObject(vbox)
|
|
86
|
+
progress = mach.launchVMProcess(session, "gui", "")
|
|
87
|
+
progress.waitForCompletion(-1)
|
|
88
|
+
mgr.closeMachineSession(session)
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
License
|
|
92
|
+
-------
|
|
93
|
+
|
|
94
|
+
Although I've listed this repository as being licensed under "The Unlicense",
|
|
95
|
+
I am not the originator of the code. The license information in SDKRef.pdf
|
|
96
|
+
(in the docs folder) contains this explanation of the code's license:
|
|
97
|
+
|
|
98
|
+
The sample code files shipped with the SDK are generally licensed
|
|
99
|
+
liberally to make it easy for anyone to use this code for their own
|
|
100
|
+
application code.
|
|
101
|
+
|
|
102
|
+
The Java files under bindings/webservice/java/jax-ws/ (library files for
|
|
103
|
+
the object-oriented web service) are, by contrast, licensed under the GNU
|
|
104
|
+
Lesser General Public License (LGPL) V2.1.
|
|
105
|
+
|
|
106
|
+
See sdk/bindings/webservice/java/jax-ws/src/COPYING.LIB for the full text
|
|
107
|
+
of the LGPL 2.1.
|
|
108
|
+
|
|
109
|
+
When in doubt, please refer to the individual source code files shipped
|
|
110
|
+
with this SDK.
|
|
111
|
+
|
|
112
|
+
My hope is that by storing the SDK here, it will be of use to those who want to
|
|
113
|
+
install the library from pip as well as those working with Git repositories
|
|
114
|
+
exclusively, but I cannot take responsibility for the code as provided by
|
|
115
|
+
Oracle.
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
.. _GitHub: https://github.com/mmabey/vbox_sdk
|
|
119
|
+
.. _PyPI: https://pypi.python.org/pypi/vbox_sdk
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
vboxapi/VirtualBox_constants.py,sha256=IjQ-NlPoSHBk_EYl7gMK80rpNXUBdxip2zXFBr14CiA,136094
|
|
2
|
+
vboxapi/__init__.py,sha256=s_CEATRP-rBRgT48x_yDlZePDyLUf8DdMz7yDzfs4os,42502
|
|
3
|
+
vbox_sdk-6.0.0.dist-info/WHEEL,sha256=EmLkUISDECbcUx3FMCYOqokNOJqNp2r0d4mJzjErvvs,80
|
|
4
|
+
vbox_sdk-6.0.0.dist-info/METADATA,sha256=S093TaaSV91mwMsrkWVwFAnbhjOmKT_qPnVEIN2Va1M,4335
|
|
5
|
+
vbox_sdk-6.0.0.dist-info/RECORD,,
|