Metadata-Version: 1.1
Name: ifbcloud
Version: 0.1.1
Summary: Commandline utility to start and stop instances on the french IFB cloud
Home-page: https://github.com/mvdbeek/ifbcloud
Author: Marius van den Beek
Author-email: m.vandenbeek@gmail.com
License: MIT
Description: ifbcloud commandline utility
        ----------------------------
        
        This is a commandline utility to 
        
          - quickly get the status of instances launched
          - start new instances
          - stop instances
        
        Installation
        ------------
        
        ``pip install ifbcloud``
        
        Useage:
        -------
        
        To get the current status, do
        
        ``ifbcoud status -u <your_ifb_username> -p <your_ifb_password>``
        
        To lauch a new instance, do
        
        ``ifbcloud start -u <your_ifb_username> -p <your_ifb_password> -n <name_for_your_instance>``
        
        To see your currently defined disks, do
        
        ``ifbcloud disks -u <your_ifb_username> -p <your_ifb_password>``
        
        To launch an instance and attach the disk named ``disk0``, do
        
        ``ifbcloud start -u <your_ifb_username> -p <your_ifb_password> -n <name_for_your_instance> -dn disk0``
        
        To stop an instance, do
        
        ``ifbcloud stop -u <your_ifb_username> -p <your_ifb_password> -n <name_for_your_instance>``
        
        To get a list of available appliances, do
        
        ``ifbcloud appliances -u <your_ifb_username> -p <your_ifb_password>``
        
        To start an appliances different from the default (Docker 16.07), e.g "BIO ComputeNode (16.07.2)", do
        
        ``ifbcloud start -u <your_ifb_username> -p <your_ifb_password> -n <name_for_your_instance> -a "BIO ComputeNode (16.07.2)"``
        
        More options are available in the subcommands help section.
        
        Shortcuts
        ---------
        If you don't want to repetitively type your username and password (and have it stored in your shell's history),
        you can export the environmental variables ``IFB_USERNAME`` and ``IFB_PASSWORD`` and omit the ``-u`` and ``-p`` options.
        
        Limitations
        -----------
        
        You can attach permanent storage to your new instances, but you first need to manually create the disks
        in the `IFB cloud storage interface <https://cloud.france-bioinformatique.fr/cloud/storage/>`_.
        
        This utility is not using any public API, just reverse-engineered from the browser's post requests, so this may
        start failing at any time if the IFB upgrades their cloud service.
        
        
        
        
        History
        -------
        
        .. to_doc
        
        ---------------------
        0.1.1 (2016-09-19)
        ---------------------
        
        * Support for selecting appliance (See ``ifbcloud appliances`` for a list of available appliances)
        
        ---------------------
        0.1.0 (2016-09-19)
        ---------------------
        
        * Support specifying permanent disks to attach to instance
        * Support disk subcommand to show available disks
        
        ---------------------
        0.0.2 (2016-09-11)
        ---------------------
        
        * Initial version
Keywords: IFB
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: Operating System :: POSIX
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Testing
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
