Fix how to handle env vars on examples and onprem tests (#70)

* how to handle correctly environment parameters

* fix rest of examples

* fix onpremises tests

* bump to 1.1.2 version

* Update NEWS

NEWS

@@ -1,3 +1,7 @@
+Dec-27-2017: version 1.1.2
+ - Fix on examples management of environment variables (#70)
+ - Fix onpremises tests (#70)
+
 Oct-26-2017: version 1.1.1
  - Fix for using with non-organization users (#67)
  - Fix in filter function (#68)

doc/source/conf.py

@@ -55,9 +55,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'1.1.1'
+version = u'1.1.2'
 # The full version, including alpha/beta/rc tags.
-release = u'1.1.1'
+release = u'1.1.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

examples/change_dataset_privacy.py

@@ -28,29 +28,34 @@
                     help='One of: LINK, PUBLIC, PRIVATE')
 
 parser.add_argument('--organization', type=str, dest='organization',
-                    default=os.environ['CARTO_ORG'],
+                    default=os.environ['CARTO_ORG'] if 'CARTO_ORG' in os.environ else '',
                     help='Set the name of the organization' +
                     ' account (defaults to env variable CARTO_ORG)')
 
 parser.add_argument('--base_url', type=str, dest='CARTO_BASE_URL',
-                    default=os.environ['CARTO_API_URL'],
+                    default=os.environ['CARTO_API_URL'] if 'CARTO_API_URL' in os.environ else '',
                     help='Set the base URL. For example:' +
                     ' https://username.carto.com/ ' +
                     '(defaults to env variable CARTO_API_URL)')
 
 parser.add_argument('--api_key', dest='CARTO_API_KEY',
-                    default=os.environ['CARTO_API_KEY'],
+                    default=os.environ['CARTO_API_KEY'] if 'CARTO_API_KEY' in os.environ else '',
                     help='Api key of the account' +
                     ' (defaults to env variable CARTO_API_KEY)')
 
 args = parser.parse_args()
 
 # Set authentification to CARTO
-auth_client = APIKeyAuthClient(
-    args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
+if args.CARTO_BASE_URL and args.CARTO_API_KEY and args.organization:
+    auth_client = APIKeyAuthClient(
+        args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
+    dataset_manager = DatasetManager(auth_client)
+    dataset = dataset_manager.get(args.dataset_name)
+else:
+    logger.error('You need to provide valid credentials, run with -h parameter for details')
+    import sys
+    sys.exit(1)
 
-dataset_manager = DatasetManager(auth_client)
-dataset = dataset_manager.get(args.dataset_name)
 # PRIVATE, PUBLIC, LINK
 dataset.privacy = args.privacy
 dataset.save()

examples/check_query.py

@@ -25,27 +25,32 @@
                     help='Set query to analyze')
 
 parser.add_argument('--organization', type=str, dest='organization',
-                    default=os.environ['CARTO_ORG'],
+                    default=os.environ['CARTO_ORG'] if 'CARTO_ORG' in os.environ else '',
                     help='Set the name of the organization' +
                     ' account (defaults to env variable CARTO_ORG)')
 
 parser.add_argument('--base_url', type=str, dest='CARTO_BASE_URL',
-                    default=os.environ['CARTO_API_URL'],
+                    default=os.environ['CARTO_API_URL'] if 'CARTO_API_URL' in os.environ else '',
                     help='Set the base URL. For example:' +
                     ' https://username.carto.com/ ' +
                     '(defaults to env variable CARTO_API_URL)')
 
 parser.add_argument('--api_key', dest='CARTO_API_KEY',
-                    default=os.environ['CARTO_API_KEY'],
+                    default=os.environ['CARTO_API_KEY'] if 'CARTO_API_KEY' in os.environ else '',
                     help='Api key of the account' +
                     ' (defaults to env variable CARTO_API_KEY)')
 
 args = parser.parse_args()
 
 # Authenticate to CARTO account
-auth_client = APIKeyAuthClient(
-    args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
-dataset_manager = DatasetManager(auth_client)
+if args.CARTO_BASE_URL and args.CARTO_API_KEY and args.organization:
+    auth_client = APIKeyAuthClient(
+        args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
+    dataset_manager = DatasetManager(auth_client)
+else:
+    logger.error('You need to provide valid credentials, run with -h parameter for details')
+    import sys
+    sys.exit(1)
 
 # SQL wrapper
 sql = SQLClient(APIKeyAuthClient(args.CARTO_BASE_URL, args.CARTO_API_KEY))

examples/create_anonymous_map.py

@@ -26,28 +26,34 @@
                     help='Path to the anonymous map JSON description file')
 
 parser.add_argument('--organization', type=str, dest='organization',
-                    default=os.environ['CARTO_ORG'],
+                    default=os.environ['CARTO_ORG'] if 'CARTO_ORG' in os.environ else '',
                     help='Set the name of the organization' +
                     ' account (defaults to env variable CARTO_ORG)')
 
 parser.add_argument('--base_url', type=str, dest='CARTO_BASE_URL',
-                    default=os.environ['CARTO_API_URL'],
+                    default=os.environ['CARTO_API_URL'] if 'CARTO_API_URL' in os.environ else '',
                     help='Set the base URL. For example:' +
                     ' https://username.carto.com/ ' +
                     '(defaults to env variable CARTO_API_URL)')
 
 parser.add_argument('--api_key', dest='CARTO_API_KEY',
-                    default=os.environ['CARTO_API_KEY'],
+                    default=os.environ['CARTO_API_KEY']  if 'CARTO_API_KEY' in os.environ else '',
                     help='Api key of the account' +
                     ' (defaults to env variable CARTO_API_KEY)')
 
 args = parser.parse_args()
 
 # Set authentification to CARTO
-auth_client = APIKeyAuthClient(
-    args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
+if args.CARTO_BASE_URL and args.CARTO_API_KEY and args.organization:
+    auth_client = APIKeyAuthClient(
+        args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
+    anonymous = AnonymousMap(auth_client)
+else:
+    logger.error('You need to provide valid credentials, run with -h parameter for details')
+    import sys
+    sys.exit(1)
+
 
-anonymous = AnonymousMap(auth_client)
 with open(args.anonymous_map_json) as anonymous_map_json:
     template = json.load(anonymous_map_json)
 

examples/create_named_map.py

@@ -26,29 +26,34 @@
                     help='Path to the named map JSON description file')
 
 parser.add_argument('--organization', type=str, dest='organization',
-                    default=os.environ['CARTO_ORG'],
+                    default=os.environ['CARTO_ORG'] if 'CARTO_ORG' in os.environ else '',
                     help='Set the name of the organization' +
                     ' account (defaults to env variable CARTO_ORG)')
 
 parser.add_argument('--base_url', type=str, dest='CARTO_BASE_URL',
-                    default=os.environ['CARTO_API_URL'],
+                    default=os.environ['CARTO_API_URL'] if 'CARTO_API_URL' in os.environ else '',
                     help='Set the base URL. For example:' +
                     ' https://username.carto.com/ ' +
                     '(defaults to env variable CARTO_API_URL)')
 
 parser.add_argument('--api_key', dest='CARTO_API_KEY',
-                    default=os.environ['CARTO_API_KEY'],
+                    default=os.environ['CARTO_API_KEY'] if 'CARTO_API_KEY' in os.environ else '',
                     help='Api key of the account' +
                     ' (defaults to env variable CARTO_API_KEY)')
 
 args = parser.parse_args()
 
 # Set authentification to CARTO
-auth_client = APIKeyAuthClient(
-    args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
+if args.CARTO_BASE_URL and args.CARTO_API_KEY and args.organization:
+    auth_client = APIKeyAuthClient(
+        args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
+    named_map_manager = NamedMapManager(auth_client)
+    n = NamedMap(named_map_manager.client)
+else:
+    logger.error('You need to provide valid credentials, run with -h parameter for details')
+    import sys
+    sys.exit(1)
 
-named_map_manager = NamedMapManager(auth_client)
-n = NamedMap(named_map_manager.client)
 
 with open(args.named_map_json) as named_map_json:
     template = json.load(named_map_json)

examples/export_create_tables.py

@@ -14,27 +14,32 @@
     description='Exports the CREATE TABLE scripts of all the account datasets')
 
 parser.add_argument('--organization', type=str, dest='organization',
-                    default=os.environ['CARTO_ORG'],
+                    default=os.environ['CARTO_ORG'] if 'CARTO_ORG' in os.environ else '',
                     help='Set the name of the organization' +
                     ' account (defaults to env variable CARTO_ORG)')
 
 parser.add_argument('--base_url', type=str, dest='CARTO_BASE_URL',
-                    default=os.environ['CARTO_API_URL'],
+                    default=os.environ['CARTO_API_URL'] if 'CARTO_API_URL' in os.environ else '',
                     help='Set the base URL. For example:' +
                     ' https://username.carto.com/ ' +
                     '(defaults to env variable CARTO_API_URL)')
 
 parser.add_argument('--api_key', dest='CARTO_API_KEY',
-                    default=os.environ['CARTO_API_KEY'],
+                    default=os.environ['CARTO_API_KEY'] if 'CARTO_API_KEY' in os.environ else '',
                     help='Api key of the account' +
                     ' (defaults to env variable CARTO_API_KEY)')
 
 args = parser.parse_args()
 
 # Authenticate to CARTO account
-auth_client = APIKeyAuthClient(
-    args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
-dataset_manager = DatasetManager(auth_client)
+if args.CARTO_BASE_URL and args.CARTO_API_KEY and args.organization:
+    auth_client = APIKeyAuthClient(
+        args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
+    dataset_manager = DatasetManager(auth_client)
+else:
+    logger.error('You need to provide valid credentials, run with -h parameter for details')
+    import sys
+    sys.exit(1)
 
 # SQL wrapper
 sql = SQLClient(APIKeyAuthClient(args.CARTO_BASE_URL, args.CARTO_API_KEY))

examples/export_dataset.py

@@ -20,18 +20,18 @@
     description='Exports a dataset')
 
 parser.add_argument('--organization', type=str, dest='organization',
-                    default=os.environ['CARTO_ORG'],
+                    default=os.environ['CARTO_ORG']  if 'CARTO_ORG' in os.environ else '',
                     help='Set the name of the organization' +
                     ' account (defaults to env variable CARTO_ORG)')
 
 parser.add_argument('--base_url', type=str, dest='CARTO_BASE_URL',
-                    default=os.environ['CARTO_API_URL'],
+                    default=os.environ['CARTO_API_URL'] if 'CARTO_API_URL' in os.environ else '',
                     help='Set the base URL. For example:' +
                     ' https://username.carto.com/ ' +
                     '(defaults to env variable CARTO_API_URL)')
 
 parser.add_argument('--api_key', dest='CARTO_API_KEY',
-                    default=os.environ['CARTO_API_KEY'],
+                    default=os.environ['CARTO_API_KEY'] if 'CARTO_API_KEY' in os.environ else '',
                     help='Api key of the account' +
                     ' (defaults to env variable CARTO_API_KEY)')
 
@@ -47,8 +47,13 @@
 
 
 # Authenticate to CARTO account
-auth_client = APIKeyAuthClient(
-    args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
+if args.CARTO_BASE_URL and args.CARTO_API_KEY and args.organization:
+    auth_client = APIKeyAuthClient(
+        args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
+else:
+    logger.error('You need to provide valid credentials, run with -h parameter for details')
+    import sys
+    sys.exit(1)
 
 # SQL wrapper
 sql = SQLClient(APIKeyAuthClient(args.CARTO_BASE_URL, args.CARTO_API_KEY))

examples/export_map.py

@@ -25,28 +25,32 @@
                     help='The name of the map in CARTO')
 
 parser.add_argument('--organization', type=str, dest='organization',
-                    default=os.environ['CARTO_ORG'],
+                    default=os.environ['CARTO_ORG'] if 'CARTO_ORG' in os.environ else '',
                     help='Set the name of the organization' +
                     ' account (defaults to env variable CARTO_ORG)')
 
 parser.add_argument('--base_url', type=str, dest='CARTO_BASE_URL',
-                    default=os.environ['CARTO_API_URL'],
+                    default=os.environ['CARTO_API_URL'] if 'CARTO_API_URL' in os.environ else '',
                     help='Set the base URL. For example:' +
                     ' https://username.carto.com/ ' +
                     '(defaults to env variable CARTO_API_URL)')
 
 parser.add_argument('--api_key', dest='CARTO_API_KEY',
-                    default=os.environ['CARTO_API_KEY'],
+                    default=os.environ['CARTO_API_KEY'] if 'CARTO_API_KEY' in os.environ else '',
                     help='Api key of the account' +
                     ' (defaults to env variable CARTO_API_KEY)')
 
 args = parser.parse_args()
 
 # Set authentification to CARTO
-auth_client = APIKeyAuthClient(
-    args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
-
-visualization = VisualizationManager(auth_client).get(args.map_name)
+if args.CARTO_BASE_URL and args.CARTO_API_KEY and args.organization:
+    auth_client = APIKeyAuthClient(
+        args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
+    visualization = VisualizationManager(auth_client).get(args.map_name)
+else:
+    logger.error('You need to provide valid credentials, run with -h parameter for details')
+    import sys
+    sys.exit(1)
 
 url = visualization.export()
 

examples/import_and_merge.py

@@ -33,26 +33,31 @@
                     ' "files/*.csv"')
 
 parser.add_argument('--organization', type=str, dest='organization',
-                    default=os.environ['CARTO_ORG'],
+                    default=os.environ['CARTO_ORG'] if 'CARTO_ORG' in os.environ else '',
                     help='Set the name of the organization' +
                     ' account (defaults to env variable CARTO_ORG)')
 
 parser.add_argument('--base_url', type=str, dest='CARTO_BASE_URL',
-                    default=os.environ['CARTO_API_URL'],
+                    default=os.environ['CARTO_API_URL'] if 'CARTO_API_URL' in os.environ else '',
                     help='Set the base URL. For example:' +
                     ' https://username.carto.com/ ' +
                     '(defaults to env variable CARTO_API_URL)')
 
 parser.add_argument('--api_key', dest='CARTO_API_KEY',
-                    default=os.environ['CARTO_API_KEY'],
+                    default=os.environ['CARTO_API_KEY'] if 'CARTO_API_KEY' in os.environ else '',
                     help='Api key of the account' +
                     ' (defaults to env variable CARTO_API_KEY)')
 
 args = parser.parse_args()
 
 # Set authentification to CARTO
-auth_client = APIKeyAuthClient(
-    args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
+if args.CARTO_BASE_URL and args.CARTO_API_KEY and args.organization:
+    auth_client = APIKeyAuthClient(
+        args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
+else:
+    logger.error('You need to provide valid credentials, run with -h parameter for details')
+    import sys
+    sys.exit(1)
 
 # get username from base_url
 substring = re.search('https://(.+?).carto.com', args.CARTO_BASE_URL)

examples/import_from_database.py

@@ -39,26 +39,31 @@
                     help='An external database connection JSON object')
 
 parser.add_argument('--organization', type=str, dest='organization',
-                    default=os.environ['CARTO_ORG'],
+                    default=os.environ['CARTO_ORG'] if 'CARTO_ORG' in os.environ else '',
                     help='Set the name of the organization' +
                     ' account (defaults to env variable CARTO_ORG)')
 
 parser.add_argument('--base_url', type=str, dest='CARTO_BASE_URL',
-                    default=os.environ['CARTO_API_URL'],
+                    default=os.environ['CARTO_API_URL'] if 'CARTO_API_URL' in os.environ else '',
                     help='Set the base URL. For example:' +
                     ' https://username.carto.com/ ' +
                     '(defaults to env variable CARTO_API_URL)')
 
 parser.add_argument('--api_key', dest='CARTO_API_KEY',
-                    default=os.environ['CARTO_API_KEY'],
+                    default=os.environ['CARTO_API_KEY'] if 'CARTO_API_KEY' in os.environ else '',
                     help='Api key of the account' +
                     ' (defaults to env variable CARTO_API_KEY)')
 
 args = parser.parse_args()
 
 # Set authentification to CARTO
-auth_client = APIKeyAuthClient(
-    args.CARTO_BASE_URL, args.CARTO_API_KEY, "organization")
+if args.CARTO_BASE_URL and args.CARTO_API_KEY and args.organization:
+    auth_client = APIKeyAuthClient(
+        args.CARTO_BASE_URL, args.CARTO_API_KEY, args.organization)
+else:
+    logger.error('You need to provide valid credentials, run with -h parameter for details')
+    import sys
+    sys.exit(1)
 
 # get username from base_url
 substring = re.search('https://(.+?).carto.com', args.CARTO_BASE_URL)