File: index.rst

package info (click to toggle)
transip 2.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 256 kB
  • sloc: python: 1,280; makefile: 18; sh: 4
file content (58 lines) | stat: -rw-r--r-- 1,192 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
Welcome to transip-api's documentation!
=======================================

This library aims to implement the TransIP API in Python.

Here is an example of a simple Python program:

.. code-block:: python

   from transip.service.vps import VpsService


   PRIVATE_KEY = '''
   -----BEGIN PRIVATE KEY-----
   ...
   -----END PRIVATE KEY-----
   '''

   # You can specify the private key directly or supply the path to the private
   # key file. The private_key_file will default to `decrypted_key`.
   client = VpsService('accountname', private_key_file='/path/to/decrypted_key')
   client = VpsService('accountname', private_key=PRIVATE_KEY)

   # Order a Vps without addons:
   client.order_vps('vps-bladevps-x1', None, 'ubuntu-18.04', 'vps-name')

You can get the library directly from PyPI::

   pip install transip-api

Documentation
-------------

This part of the documentation guides you through all of the library's
usage patterns.

.. toctree::
   :maxdepth: 2

   quickstart
   cli
   api

Miscellaneous Pages
-------------------

.. toctree::
   :maxdepth: 2

   contrib
   license

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`