Merge pull request #80 from Syncano/release-v0.8

[RELEASE v0.8]

Author: opalczynski

.isort.cfg

@@ -2,4 +2,4 @@
 line_length=120
 multi_line_output=3
 default_section=THIRDPARTY
-skip=.eggs,egg-info,builds,dist,dev.py
+skip=.eggs,egg-info,builds,dist,dev.py,.tox,scripts

README.rst

@@ -53,6 +53,34 @@ The instance name will be set as default and used in all CLI commands.
 If you want to override this setting for a specific command, use --instance-name eg::
 
     syncano sync --instance-name new-instance-1234 pull
+    
+If you need to change default instance name, used for all future commands, use::
+
+    syncano default name_of_new_default_instance
+
+
+If you do not have an Syncano account use `syncano init` command::
+
+    syncano init
+
+And follow the steps. CLI will ask you about `email` and `password`, it will also create an Instance for you.
+After `syncano init` you can start with getting the list of your Instances::
+
+    syncano instances list
+
+
+To obtain a help, type::
+
+    syncano --help
+
+To display a help for specific command, type::
+
+    syncano instances --help
+
+And::
+
+    syncano instances list --help
+
 
 Documentation
 =============
@@ -107,8 +135,8 @@ Will display custom sockets from `my_instance_name` - because it is set to be a
 
 After a registration - there's no default instance set. So it's desired to create one and set it as default::
 
-    syncano instance create my_new_instance
-    syncano instance default my_new_instance
+    syncano instances create my_new_instance
+    syncano instances default my_new_instance
 
 It's worth to note that `instance_name` must be unique - but you will get appropriate message if you encounter such case.
 
@@ -259,19 +287,19 @@ Syncano Hosting
 Syncano Hosting is a simple way to host your static files on Syncano servers. 
 The CLI supports it in the following way:
 
-This command will list files for currently hosted website::
+This command will list currently defined hostings in the instance::
 
     syncano hosting list
 
+This command will list files for currently hosted website (for `default` hosting)::
+
+    syncano hosting list files
+
 This command will publish all files inside *<base_dir>* to the default Syncano Hosting instance.
 When publishing the whole directory, the structure will be mapped on Syncano.::
 
     syncano hosting publish <base_dir>
 
-This command will unpublish currently published hosting::
-
-    syncano hosting unpublish
-
 
 This command will permamently delete the hosting::
 
@@ -285,6 +313,14 @@ This command will update single file::
 
     syncano hosting update hosting/file/path local/file/path
 
+For each of the above command you can specify the domain to change just after hosting command, example::
+
+    syncano hosting --domain staging publish <base_dir>
+
+Will create a new hosting which will be available under: `<instance_name>--staging.syncano.site`
+If this hosting is also a default one, it will be available under: `<instance_name>.syncano.site`.
+
+
 Custom Sockets
 ==============
 
@@ -311,6 +347,10 @@ Display chosen Custom Socket details::
 
     syncano sockets details socket_name
 
+Display Custom Socket config (with name: `socket_name`)::
+
+    syncano sockets config socket_name
+
 Delete a Custom Socket::
 
     syncano sockets delete socket_name
@@ -323,14 +363,15 @@ Create a template from an existing Custom Socket::
 
     syncano sockets template /path/to/out --socket socket_name
 
-Run endpoint defined in Custom Socket::s
+Run endpoint defined in Custom Socket::
 
     syncano sockets run socket_name/endpoint_name
 
 Run endpoint providing POST data::
 
     syncano sockets run socket_name/my_endpoint_12 POST -d one=1
 
+
 In all of the above cases you can override the Syncano instance being used::
 
     --instance-name my_instance_name

circle.yml

@@ -1,18 +1,18 @@
 machine:
   python:
-    version: 2.7.5
+    version: 2.7.10
 
 dependencies:
   pre:
     - pip install -U setuptools
+    - pip install -r requirements-tests.txt
+  post:
+    - pyenv local 3.4.3 2.7.10
 
 test:
   override:
-    - pip install -r requirements-tests.txt
-    - flake8 .
-    - isort --recursive --check-only .
     - python setup.py check -s --restructuredtext
-    - python setup.py test
+    - tox
 
 deployment:
   production:

docs/custom_sockets/docs.md

@@ -7,6 +7,13 @@
     author:
       name: Sebastian
       email: sebastian@syncano.com
+    config:
+      constants:
+        secret_key: value
+      prompt:
+        user_key:
+          type: string
+          description: A Syncano user key
     icon:
       name: icon_name
       color: red
@@ -34,6 +41,20 @@
           runtime_name: python_library_v5.0
           file: scripts/script3.py
 
+      classes:
+        country:
+          schema:
+            - name: name
+              type: string
+            - name: topLevelDomain
+              type: string
+            - name: capital
+              type: string
+            - name: alpha2Code
+              type: string
+            - name: alpha3Code
+              type: string
+
 ### YAML file structure explanation
 
 * `name` is the name of your new Custom Socket - this should be unique;
@@ -46,6 +67,8 @@
     * can be found in `metadata` field on Custom Socket in Syncano Dasboard.
 * `icon` is metadata information about your Custom Socket - it stores the icon name used and its color (used in Syncano Dashboard)
 * `endpoints` - definition of the endpoints in a Custom Socket; Currently supported endpoints can be only of `script` type.
+* `config` - stores the metadata about custom socket configuration; constants are config variables that are passed one-to-one
+  from yaml file definitions; the `prompt` config section - this variables will be requested from user during installation.
 
     Consider this example:
 
@@ -76,8 +99,8 @@
     The difference is that we now define what happens for the different HTTP methods. When the GET HTTP method is used, 
     `script_endpoint_3` script endpoint will be run. When the POST HTTP method is used - `script_endpoint_2` endpoint will be executed. 
 
-    Currently only Script Endpoints are supported, which run scripts under the hood. But don't worry, 
-    we are working on adding more options!
+    Currently Script Endpoints and Classes are supported, which run scripts under the hood.  
+    We are working on adding more options!
 
 * `dependencies` - the definition of your Custom Socket dependencies. They define all dependency objects
 which will be called when the endpoint is requested. 
@@ -90,7 +113,7 @@ which will be called when the endpoint is requested.
            runtime_name: python_library_v5.0
            file: scripts/script1.py
 
-    Above YAML snippet defines one dependency:
+    Above YAML snippet defines four dependencies (three of type `script` and one of type `class`):
     * `script` - type of the dependency (defined using `scripts` keyword). 
         * `script_endpoint_1` - name of the dependency; it's an important element, because that's the place where you connect a dependency to an endpoint. 
             * `runtime_name` is name of the runtime used in a script; 
@@ -99,6 +122,26 @@ which will be called when the endpoint is requested.
     It should be noted that when defining Custom Scripts, we suggest following some basic directory structure- for
     better work organization. We recommend storing scripts under the `scripts` directory - this is why the filename 
     is a relative path: `scripts/script1.py`. Of course your can also follow your own rules,  e.g. by using a flat file structure.
+    
+    The class dependency looks as follows:
+        
+        classes:
+          country:
+            schema:
+              - name: name
+                type: string
+              - name: topLevelDomain
+                type: string
+              - name: capital
+                type: string
+              - name: alpha2Code
+                type: string
+              - name: alpha3Code
+                type: string
+                
+    This simple mean that Custom Socket requires a class `country` to work properly. Under the hood - Syncano Platform
+    will check if this class exists (if not - create it) and ensure that all required files defined in `schema` are present.
+        
 
 
 ## Custom Socket directory structure

requirements-tests.txt

@@ -1,3 +1,4 @@
+tox==2.3.1
 flake8==2.4.1
 isort==4.0.0
 mock==1.3.0

run_tests.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+set -e
+
+flake8 .
+isort --recursive --check-only .
+
+python setup.py test

setup.py

@@ -6,15 +6,15 @@
 
 setup(
     name='syncano-cli',
-    version='0.7',
+    version='0.8',
     description='Syncano command line utilities',
     long_description=README,
     author='Marcin Swiderski, Sebastian Opalczynski',
     author_email='marcin.swiderski@syncano.com, sebastian.opalczynski@syncano.com',
     url='https://github.com/Syncano/syncano-cli',
     packages=find_packages(),
     license='MIT',
-    install_requires=['syncano>=5.4.2', 'PyYaml>=3.11', 'watchdog>=0.8.3', 'click>=6.6'],
+    install_requires=['syncano>=5.4.4', 'PyYaml>=3.11', 'watchdog>=0.8.3', 'click>=6.6'],
     test_suite='tests',
     entry_points="""
         [console_scripts]

syncano_cli/account/command.py

@@ -10,7 +10,7 @@ def __init__(self, config_path):
         self.connection = syncano.connect()
         self.config_path = config_path
 
-    def register(self, email, password, first_name, last_name, invitation_key):
+    def register(self, email, password, first_name=None, last_name=None, invitation_key=None):
         api_key = self.connection.connection().register(
             email=email,
             password=password,
@@ -19,6 +19,6 @@ def register(self, email, password, first_name, last_name, invitation_key):
             invitation_key=invitation_key
         )
 
-        ACCOUNT_CONFIG.set('DEFAULT', 'api_key', api_key)
-        with open(self.config_path, 'wb') as fp:
+        ACCOUNT_CONFIG.set('DEFAULT', 'key', api_key)
+        with open(self.config_path, 'wt') as fp:
             ACCOUNT_CONFIG.write(fp)

syncano_cli/account/commands.py

@@ -12,9 +12,7 @@ def top_account():
 @click.pass_context
 @click.option('--config', help=u'Account configuration file.')
 def accounts(ctx, config):
-    """
-    Handle Syncano account functionality;
-    """
+    """Handle Syncano account functionality."""
     account_commands = AccountCommands(config_path=config or ACCOUNT_CONFIG_PATH)
     ctx.obj['account_commands'] = account_commands
 

syncano_cli/base/connection.py

@@ -1,11 +1,17 @@
 # -*- coding: utf-8 -*-
-from ConfigParser import NoOptionError, NoSectionError
-
+import six
 import syncano
 from syncano.exceptions import SyncanoException
 from syncano_cli.base.exceptions import BadCredentialsException, InstanceNotFoundException
 from syncano_cli.config import ACCOUNT_CONFIG, ACCOUNT_CONFIG_PATH
 
+if six.PY2:
+    from ConfigParser import NoOptionError, NoSectionError
+elif six.PY3:
+    from configparser import NoOptionError, NoSectionError
+else:
+    raise ImportError()
+
 
 def get_instance_name(config, instance_name):
     ACCOUNT_CONFIG.read(config)