Metadata-Version: 1.1
Name: cartodb_backup
Version: 0.1
Summary: Python CLI to make a backup of an entire CartoDB domain to SQL dump file (zipped). Optionally you can restore SQL dumped file to a new (created) PostGIS DB. Also you can upload sql files to Amazon S3.
Home-page: http://github.com/GeographicaGS/CartoDB_Backup
Author: Cayetano Benavent
Author-email: cayetano.benavent@geographica.gs
License: GPLv2
Description: CartoDB Backup
        ==============
        
        Python CLI to make a backup of an entire CartoDB domain to SQL dump file
        (zipped).
        
        Optional:
        
        -  You can restore SQL dumped file to a new (created) PostGIS DB.
        -  You can upload sql files to Amazon S3.
        -  Message from Amazon SNS (Simple Notification Service).
        
        Before execute this script you need a cartodbbkconfig.py file properly
        formed (See cartodbbkconfig\_example.py).
        
        cartodbbkconfig.py config parameters:
        
        .. code:: python
        
            confparams = {
                            "cdb_apikey": "here your api key",
                            "cdb_domain": "here your domain",
                            "sql_folderpath": "here your dump folderpath",
                            "pg_user": "here your db admin user",
                            "pg_pswd": None, # If you leave the password to None, the program will ask you in the command line interface
                            "pg_dbase": "here your db name",
                            "pg_host": "here your db host",
                            "pg_port": "here your db port",
                            "pg_newdatabase": "here your new db name",
                            "aws_acckey": "here your AWS Acces Key",
                            "aws_seckey": "here your AWS Secret Key",
                            "aws_bucket": "here your AWS bucket",
                            "aws_prekey": "here your AWS bucket prefix key",
                            "sns_regname": "here your AWS region name",
                            "sns_arn": "here your SNS ARN",
                            "sns_subject": "My project"
                        }
        
        Installation
        ------------
        
        -  This is a Python CLI. This CLI must be installed in this way (It will
           soon be in PyPI):
        
           .. code:: bash
        
               $ python setup.py install
        
        Usage
        -----
        
        Python CLI:
        
        .. code:: bash
        
            $ cartodb_backup [-h] configfile [--postgis_backup] [--aws_s3upload]
                             [--amz_sns] [--rmv_localfl]
        
            positional arguments:
              configfile            Config filepath: /folderlocation/
        
            optional arguments:
              -h, --help            show this help message and exit
              --postgis_backup      POSTGIS_BACKUP PostGIS backup (restoring dump file created)
              --aws_s3upload        Upload file to Amazon S3
              --amz_sns             Amazon SNS message
              --rmv_localfl         Remove local file after a successfully Amazon S3 upload
        
        Example without PostGIS backup:
        
        .. code:: bash
        
            $ cartodb_backup /folderlocation/
        
        Example with PostGIS backup:
        
        .. code:: bash
        
            $ cartodb_backup /folderlocation/ --postgis_backup
        
        Example with Amazon S3 upload:
        
        .. code:: bash
        
            $ cartodb_backup /folderlocation/ --aws_s3upload
        
        Example with Amazon S3 upload and Amazon SNS (removing local sql folder
        after upload):
        
        .. code:: bash
        
            $ cartodb_backup /folderlocation/ --aws_s3upload --amz_sns --rmv_localfl
        
        Requirements
        ------------
        
        -  GDAL >= 1.11.
        -  PostgreSQL with PostGIS (1).
        -  Psycopg2 Python library (1).
        -  Python interface to Amazon Web Services (Boto) (2).
        
        (1) Only if you want to use --postgis\_backup parameter.
        (2) Only if you want to use --aws\_s3upload parameter.
        
        About author
        ------------
        
        Developed by Cayetano Benavent. GIS Analyst at Geographica.
        
        http://www.geographica.gs
        
        License
        -------
        
        This program is free software; you can redistribute it and/or modify it
        under the terms of the GNU General Public License as published by the
        Free Software Foundation; either version 2 of the License, or (at your
        option) any later version.
        
Keywords: cartodb GIS postgis
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python :: 2.7
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: GIS
