Metadata-Version: 1.1
Name: cloudomate
Version: 1.0.0
Summary: Automate buying VPS/VPN instances with Bitcoin
Home-page: https://github.com/Tribler/Cloudomate
Author: Tribler team
Author-email: plebnet@heijligers.me
License: LGPLv3
Description-Content-Type: UNKNOWN
Description: ==========
        Cloudomate
        ==========
        
        
        
        .. image:: https://jenkins.tribler.org/buildStatus/icon?job=pers/Cloudomate
           :target: https://jenkins.tribler.org/job/pers/job/Cloudomate/
           :alt: Build Status
        
        .. image:: https://files.slack.com/files-pri/T546HRL3H-F5KQ13400/cloudomate-logo.png?pub_secret=1234824941
           :alt: Cloudomate logo
        
        Overview
        ========
        
        Cloudomate is an unpermissioned open compute API which provides an automated way to buy VPS instances and VPN servers from multiple providers. The easiest way to use Cloudomate is via the command-line interface. 
        
        Requirements
        ============
        
        * Python 2 or 3
        * Works on Linux, Mac OSX, BSD
        * An active Electrum_ wallet with sufficient funds
        
        Installation
        ============
        
        The project can be installed through pip: ::
        
           pip3 install cloudomate
        
        
        Providers
        =========
        VPS
        ---------
        
        Currently the following VPS providers are implemented: ::
        
           blueangelhost         https://www.blueangelhost.com/
           ccihosting            http://www.ccihosting.com/
           crowncloud            http://crowncloud.net/
           linevast              https://linevast.de/
           pulseservers          https://pulseservers.com/
           undergroundprivate    https://undergroundprivate.com/
        
        This same list can be accessed through the list command: ::
        
           cloudomate vps list
        
        VPN
        ---------
        
        Currently the following VPN providers are implemented: ::
        
           azirevpn       https://www.azirevpn.com
        
        This same list can be accessed through the list command: ::
        
           cloudomate vpn list
        
        
        Configuration
        -------------
        
        For some commands, mainly purchase, user configuration is required. The
        main way to do this is through a configruation file. For Linux, the default
        location for the configuration file is `$HOME/.config/cloudomate.cfg`.
        
        A configuration file looks like this: ::
        
           [user]
           email =
           firstname =
           lastname =
           password =
           companyname =
           phonenumber =
           username =
        
           [address]
           address =
           city =
           state =
           countrycode =
           zipcode =
        
           [payment]
           walletpath =
        
           [server]
           ns1 =
           ns2 =
           hostname =
           root_password =
        
        
        Section can be overridden for specific providers by adding a section,
        for example a [linevast] section can contain a separate email address only
        to be used for Linevast_.
        
        
        Basic usage
        -----------
        
        ::
        
           usage: cloudomate [-h] {vps,vpn} ...
        
           Cloudomate
        
           positional arguments:
             {vps,vpn}
               
           optional arguments:
             -h, --help            show this help message and exit
             
        VPS
        ~~~~~~~~~~~
        
        ::
        
           usage: cloudomate vps [-h] 
                                 {list,options,purchase,status,setrootpw,getip,ssh,info}
                                 ...
        
           positional arguments:
             {list,options,purchase,status,setrootpw,getip,ssh,info}
               list                List VPS providers
               options             List VPS provider configurations
               purchase            Purchase VPS
               status              Get the status of the VPS services
               setrootpw           Set the root password of the last activated service
               getip               Get the IP address of the specified service
               ssh                 SSH into an active service
               info                Get information of the specified VPS service
               
           optional arguments:
             -h, --help            show this help message and exit
        
        VPN
        ~~~~~~~~~~~
        
        ::
        
           usage: cloudomate [-h] {vps,vpn} ...
        
           positional arguments:
             {list,options,purchase,status,info}
               list                List VPN providers
               options             List VPN provider configurations
               purchase            Purchase VPN
               status              Get the status of the VPN services
               info                Get information of the specified VPN service
               
           optional arguments:
             -h, --help            show this help message and exit
        
        
        options
        -------
        
        List the options for Linevast_ ::
            
            
           $ cloudomate vps options linevast
        
        ::
            
           Options for linevast:
        
              #    Name              CPU (cores)       RAM (GB)          Storage (GB)      Bandwidth (TB)    Connection (Mbps) Est. Price (mBTC) Price
              0    Basis OVZ         1                 2                 50                unmetered         1000              1.03              EUR 6.99
              1    Business OVZ      2                 4                 150               unmetered         1000              1.64              EUR 12.99
              2    Advanced OVZ      4                 8                 300               unmetered         1000              2.35              EUR 19.99
              3    Black OVZ         8                 16                1000              unmetered         1000              2.96              EUR 25.99
              4    Basic KVM         1                 2                 30                unmetered         1000              1.03              EUR 6.99
              5    Business KVM      2                 4                 50                unmetered         1000              1.64              EUR 12.99
              6    Advanced KVM      4                 8                 75                unmetered         1000              2.96              EUR 25.99
              7    Black KVM         6                 16                100               unmetered         1000              4.18              EUR 37.99
        
        
        Purchase
        --------
        
        Use the purchase command to purchase a VPS instance. An account is created
        and the instance is paid through an Electrum wallet. ::
           
           $ cloudomate vps purchase linevast 0
          
        ::
        
           Selected configuration:
           Name           CPU            RAM            Storage        Bandwidth      Est.Price
           Basis OVZ      1              2              50             unmetered      6.99
           Purchase this option? (y/N)
        
        Manage
        ------
        
        VPS
        ~~~~~~~~~~~
        
        The following functions can be used to manage a purchased VPS instance ::
        
            status              Get the status of the service.
            info                Get information of the specified service
            setrootpw           Set the root password of the last activated service.
            getip               Get the ip of the specified service.
        
        VPN
        ~~~~~~~~~~~
        The following functions can be used to manage a purchased VPN instance ::
        
            status              Get the status of the service.
            info                Get configuration of the specified service
        
        Tests
        =====
        
        To run the project's tests (make sure to install with extra_requires: [test])    ::
        
            python -m unittest discover
        
        
        
        .. _Linevast: https://linevast.de/en/
        .. _Electrum: https://electrum.org/
        
Keywords: vps vpn bitcoin captcha
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: System :: Installation/Setup
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
