Metadata-Version: 2.1
Name: pyrdsbackup
Version: 1.1.3
Summary: Simplify RDS Backups to S3
Home-page: https://github.com/darmagedon/pyrds-backup.git
Author: Sparsha Dotel
Author-email: sparshadotel@gmail.com
License: UNKNOWN
Description: <div align="center">
            <img src="assets/pyrdsbackup.png">
        
        # pyrdsbackup
        
        A library on top of pyodbc meant to simplify database backups from RDS to S3.
        </div>
        
        ## Installation
        
        ```bash
        sudo apt install -y unixodbc unixodbc-dev
        pip install pyrdsbackup
        ```
        
        ## Prerequisite
        
        [Make sure that RDS Backup is enabled for your RDS instance.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.BackupRestore.html)
        
        ## Usage
        
        ```py
        from pyrdsbackup.db import mssql
        
        # Initialize Credentials
        credentials = {
            'server': 'rdsserver.amazon',
            'username': 'adminuser',
            'password': 'password',
            'port': 1433,
            'bucket': 'bucket_name',
            'driver_version': 17
        }
        
        # Test if the connection works. If this statement returns True, backup is possible.
        mssql.test(credentials)
        
        # Backup the database
        mssql.backup(credentials, 'database_name')
        ```
        
Keywords: cli
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
