Skip to main content

Python interface to the Mythic Beasts Hosted Pi API

Project description

Python interface to the Mythic Beasts Hosted Pi API, developed by the piwheels team (Ben Nuttall and Dave Jones).

This module provides a Pythonic interface to the API, as well as a command line interface.

The authors of this library are not affiliated with Mythic Beasts, but we use their Pi cloud to power the piwheels project.

Documentation of the API itself can be found at https://www.mythic-beasts.com/support/api/raspberry-pi

Usage

View the information about a Pi from the command line:

$ hostedpi show mypi
Name: mypi
Provision status: live
Model: Raspberry Pi 3B
Disk size: 10GB
Power: on
IPv6 address: 2a00:1098:8:5b::1
IPv6 network: 2a00:1098:8:5b00::/56
Initialised keys: yes
SSH keys: 4
IPv4 SSH port: 5091
Location: MER
URLs:
  http://www.mypi.hostedpi.com
  https://www.mypi.hostedpi.com
SSH commands:
  IPv4: ssh -p 5091 root@ssh.mypi.hostedpi.com
  IPv6: ssh root@[2a00:1098:8:5b::1]

Provision a new Pi and view its SSH command (using Python):

>>> from hostedpi import PiCloud
>>> api_id = '8t29hvcux5g9vud8'
>>> secret = 'QNwsvxZY8SxT3OiLt:Vmz-D1mWQuoZ'
>>> cloud = PiCloud(api_id, secret, ssh_key_path='/home/ben/.ssh/id_rsa.pub')
>>> pi = cloud.create_pi('mypi')
>>> print(pi.ssh_command)
ssh -p 5123 root@ssh.mypi.hostedpi.com

See the getting started page for information on how to authenticate, and see the command line interface page for information on using the command line interface.

Documentation

Documentation for this module can be found at https://hostedpi.readthedocs.io/

Documentation of the API itself can be found at https://www.mythic-beasts.com/support/api/raspberry-pi

Contributing

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hostedpi-0.1.0.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

hostedpi-0.1.0-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file hostedpi-0.1.0.tar.gz.

File metadata

  • Download URL: hostedpi-0.1.0.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for hostedpi-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9dc0cb582b2502414d668675aef357d37d3be1d38f6026cfacc1d351754ed252
MD5 0dd2e8d9f8c352021d732df48816cd00
BLAKE2b-256 3d3f1b7e0573ede602edaadd326b758dbc64fda22627b86b85dc42083ea56ed0

See more details on using hashes here.

File details

Details for the file hostedpi-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: hostedpi-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for hostedpi-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e312579a25cb5383823aa7d196375f012056ce3ace57932f2a3be94ee99c6b5d
MD5 177e3e835fbcbc1bc11aad92a518ea28
BLAKE2b-256 96a73c7745dd2d99b4cdf9273ca153b4d7041cfed7f5f959e5ef7783e8739c75

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page