xbox-devportal
Async client for the Xbox (Series/One) Windows Device Portal in Developer Mode.
Installation
pip install xbox-devportal
Quick Start
import asyncio
from xbox_devportal import XboxDevPortal
async def main():
client = XboxDevPortal("10.0.0.5", username="user", password="pass")
# Fetch device info
info = await client.info()
print(f"Device: {info.computer_name} ({info.os_version})")
# Close the connection
await client.close()
asyncio.run(main())
API Reference
Device Information
| Method | Returns | Description |
|---|---|---|
info() |
DeviceInfo |
Device name, OS version, platform |
system_perf() |
SystemPerf |
CPU load, memory, GPU metrics |
processes() |
list[Process] |
All running processes with memory usage |
foreground_app() |
Process | None |
Currently active non-shell application |
screenshot() |
bytes |
PNG screenshot of current display |
Apps & Packages
| Method | Returns | Description |
|---|---|---|
packages(sideloaded_only=False) |
list[Package] |
Installed packages; filter by sideloaded_only |
launch(package) |
None |
Launch an app by package name or object |
terminate(package) |
None |
Terminate a running app |
install(local_path) |
None |
Install APPX; polls state until complete or error (60-cycle timeout) |
uninstall(package_full_name) |
None |
Uninstall package by full name |
File System (LocalAppData)
| Method | Returns | Description |
|---|---|---|
list_files(package_full_name, path) |
list[dict] |
List files in app's LocalState (e.g., //LocalState) |
upload_file(package_full_name, path, local_path, remote_name=None) |
None |
Upload file to app directory |
delete_file(package_full_name, path, filename) |
None |
Delete file from app directory |
Device Control
| Method | Returns | Description |
|---|---|---|
settings() |
dict[str, Setting] |
All device settings with options |
set_setting(name, value) |
None |
Set device setting (e.g., power mode) |
sandbox() |
str |
Current Xbox Live sandbox |
smb_credentials() |
SmbShare |
SMB share path, username, password |
restart() |
None |
Restart the device |
shutdown() |
None |
Shut down the device |
Security Notes
-
Self-Signed Certificate: The Device Portal uses HTTPS with a self-signed certificate. The client disables SSL verification by default (
ssl=False). Use only over a trusted network. -
Basic Authentication: Credentials are sent via Basic Auth (base64-encoded). Use only on a LAN behind a firewall. Do not expose the Device Portal port (default 11443) to the internet.
License
MIT
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
xbox_devportal-0.1.0.tar.gz
(107.9 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file xbox_devportal-0.1.0.tar.gz.
File metadata
- Download URL: xbox_devportal-0.1.0.tar.gz
- Upload date:
- Size: 107.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7fa105f02843afdd02e5315a43ba110943dcfed1d11772f26ed3d0208c1ab124
|
|
| MD5 |
a7c2588048627b43736be4dac10e2b5f
|
|
| BLAKE2b-256 |
cec46ea5fd1326a68a001b19ef73c482988fd0122fe9932f7c20a08802ecd399
|
File details
Details for the file xbox_devportal-0.1.0-py3-none-any.whl.
File metadata
- Download URL: xbox_devportal-0.1.0-py3-none-any.whl
- Upload date:
- Size: 6.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d45b5c8357b065b6ac7b5b90dcb922b7d40431b628e3494e467e100228a708a7
|
|
| MD5 |
8fc78c549f01c39f56e1d90ea629dab0
|
|
| BLAKE2b-256 |
f430047d9dbcbeb1c83bc6a8617d9e9a1aa5f03f9ace2ec4ae61ed40dddabf06
|
