rireki 0.0.1__tar.gz

rireki-0.0.1/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.1
+Name: rireki
+Version: 0.0.1
+Summary: CLI backup tool.
+Home-page: https://github.com/noeldemartin/rireki
+Author: Noel De Martin
+Author-email: noeldemartin@gmail.com
+License: MIT
+Description: # Rireki [![Github Actions Status](https://github.com/noeldemartin/rireki/workflows/Testing/badge.svg)](https://github.com/noeldemartin/rireki/actions)
+        
+        CLI backup tool.
+        
+        ## Installation
+        
+        Install the rireki cli running the following command:
+        
+        ```sh
+        pip install rireki
+        ```
+        
+        You need to call `rireki backup` in order for backups to be performed. For example, you could use the following crontab configuration to perform backup checks every hour (remember to create the `/var/log/rireki` directory as well):
+        
+        ```sh
+        0 * * * * rireki backup >> /var/log/rireki/cron.log 2>> /var/log/rireki/cron-error.log
+        ```
+        
+        ## Usage
+        
+        Get detailed information running `rireki --help`.
+        
+        There are three core concepts on how rireki manages backups:
+        
+        - **Projects:** A project is something you want to back up. For example a website database or a collection of files.
+        
+        - **Drivers:** A driver is the program used to create the backup files. For example zipping up a folder or dumping a database.
+        
+        - **Stores:** A store is the program used to save the backup files created with a driver. For example copying them to a local folder or uploading them to a 3rd party service.
+        
+        In order to install a new project to backup, a configuration file can be added to `~/.rireki/projects/{project-name}.conf`. This will be a [toml](https://github.com/toml-lang/toml) configuration file. It can either be created manually or calling `rireki add {project-name}`.
+        
+        ### Drivers
+        
+        #### Files
+        
+        This driver creates an archive with files copied from the local filesystem. The archive will be a zip file if possible or a tar file.
+        
+        It needs the following configuration:
+        
+        | property      | type          | description  |
+        | ------------- |---------------| -------------|
+        | name          | `"files"`     | The name of the driver. |
+        | frequency     | `integer`     | The frequency in seconds at which new backups should be made. |
+        | paths         | `string[]`    | Folders or files that will be included in the archive. |
+        
+        #### Custom
+        
+        This driver can be used if backing up a project is not supported by any of the other drivers. It consists of a custom script that will be called to generate the backup artifacts. The backup files should be placed on a path indicated by the `RIREKI_BACKUP_PATH` env variable.
+        
+        Once the script has completed, a file named `logs.json` will also be placed on the path with the standard output and standard error printed by the script.
+        
+        It needs the following configuration:
+        
+        | property      | type          | description  |
+        | ------------- |---------------| -------------|
+        | name          | `"custom"`    | The name of the driver. |
+        | frequency     | `integer`     | The frequency in seconds at which new backups should be made. |
+        | command       | `string`      | Command to call in order to perform backups. |
+        | timeout       | `integer`     | Number of seconds where the command will be timed out and the backup will fail. |
+        
+        ### Stores
+        
+        #### Local
+        
+        This store copies the backups to a folder in the same filesystem.
+        
+        It needs the following configuration:
+        
+        | property      | type          | description  |
+        | ------------- |---------------| -------------|
+        | name          | `"local"`     | The name of the store. |
+        | path          | `string`      | The path of the folder where the backups will be copied. |
+        
+        #### Amazon Web Services
+        
+        This store uploads the backups to an AWS S3 instance.
+        
+        It needs the following configuration:
+        
+        | property      | type          | description  |
+        | ------------- |---------------| -------------|
+        | name          | `"aws"`     | The name of the store. |
+        | region        | `string`      | The region where the S3 instance is located. |
+        | access_key    | `string`      | The access key ID. |
+        | access_secret | `string`      | The secret access key. |
+        | bucket        | `string`      | The name of the bucket where the files will be uploaded. |
+        | path          | `string`      | The path within the bucket where the files will be placed. |
+        
+        #### Digital Ocean
+        
+        This store uploads the backups to a Digital Ocean Spaces instance.
+        
+        It uses the same configuration as the AWS store, with the only exception that the name is `"digital-ocean"` instead.
+        
+        ### An example config file
+        
+        For example, to backup a project named "Foobar" using the `files` driver and the `local` store we would create the following file at `~/.rireki/projects/foobar.conf`:
+        
+        ```toml
+        name="foobar"
+        
+        [driver]
+        name="files"
+        paths=["/path/to/data/folder"]
+        frequency=1440
+        
+        [store]
+        name="local"
+        path="/path/to/backups/folder"
+        ```
+        
+        As mentioned before, you could call `rireki add foobar` to create this file.
+        
+        ## Development
+        
+        Run tests with `pytest` and lint your code with `flake8` (see the [Github Actions configuration](.github/workflows/testing.yml) for more details).
+        
+Platform: UNKNOWN
+Description-Content-Type: text/markdown

rireki-0.0.1/README.md

@@ -0,0 +1,117 @@
+# Rireki [![Github Actions Status](https://github.com/noeldemartin/rireki/workflows/Testing/badge.svg)](https://github.com/noeldemartin/rireki/actions)
+
+CLI backup tool.
+
+## Installation
+
+Install the rireki cli running the following command:
+
+```sh
+pip install rireki
+```
+
+You need to call `rireki backup` in order for backups to be performed. For example, you could use the following crontab configuration to perform backup checks every hour (remember to create the `/var/log/rireki` directory as well):
+
+```sh
+0 * * * * rireki backup >> /var/log/rireki/cron.log 2>> /var/log/rireki/cron-error.log
+```
+
+## Usage
+
+Get detailed information running `rireki --help`.
+
+There are three core concepts on how rireki manages backups:
+
+- **Projects:** A project is something you want to back up. For example a website database or a collection of files.
+
+- **Drivers:** A driver is the program used to create the backup files. For example zipping up a folder or dumping a database.
+
+- **Stores:** A store is the program used to save the backup files created with a driver. For example copying them to a local folder or uploading them to a 3rd party service.
+
+In order to install a new project to backup, a configuration file can be added to `~/.rireki/projects/{project-name}.conf`. This will be a [toml](https://github.com/toml-lang/toml) configuration file. It can either be created manually or calling `rireki add {project-name}`.
+
+### Drivers
+
+#### Files
+
+This driver creates an archive with files copied from the local filesystem. The archive will be a zip file if possible or a tar file.
+
+It needs the following configuration:
+
+| property      | type          | description  |
+| ------------- |---------------| -------------|
+| name          | `"files"`     | The name of the driver. |
+| frequency     | `integer`     | The frequency in seconds at which new backups should be made. |
+| paths         | `string[]`    | Folders or files that will be included in the archive. |
+
+#### Custom
+
+This driver can be used if backing up a project is not supported by any of the other drivers. It consists of a custom script that will be called to generate the backup artifacts. The backup files should be placed on a path indicated by the `RIREKI_BACKUP_PATH` env variable.
+
+Once the script has completed, a file named `logs.json` will also be placed on the path with the standard output and standard error printed by the script.
+
+It needs the following configuration:
+
+| property      | type          | description  |
+| ------------- |---------------| -------------|
+| name          | `"custom"`    | The name of the driver. |
+| frequency     | `integer`     | The frequency in seconds at which new backups should be made. |
+| command       | `string`      | Command to call in order to perform backups. |
+| timeout       | `integer`     | Number of seconds where the command will be timed out and the backup will fail. |
+
+### Stores
+
+#### Local
+
+This store copies the backups to a folder in the same filesystem.
+
+It needs the following configuration:
+
+| property      | type          | description  |
+| ------------- |---------------| -------------|
+| name          | `"local"`     | The name of the store. |
+| path          | `string`      | The path of the folder where the backups will be copied. |
+
+#### Amazon Web Services
+
+This store uploads the backups to an AWS S3 instance.
+
+It needs the following configuration:
+
+| property      | type          | description  |
+| ------------- |---------------| -------------|
+| name          | `"aws"`     | The name of the store. |
+| region        | `string`      | The region where the S3 instance is located. |
+| access_key    | `string`      | The access key ID. |
+| access_secret | `string`      | The secret access key. |
+| bucket        | `string`      | The name of the bucket where the files will be uploaded. |
+| path          | `string`      | The path within the bucket where the files will be placed. |
+
+#### Digital Ocean
+
+This store uploads the backups to a Digital Ocean Spaces instance.
+
+It uses the same configuration as the AWS store, with the only exception that the name is `"digital-ocean"` instead.
+
+### An example config file
+
+For example, to backup a project named "Foobar" using the `files` driver and the `local` store we would create the following file at `~/.rireki/projects/foobar.conf`:
+
+```toml
+name="foobar"
+
+[driver]
+name="files"
+paths=["/path/to/data/folder"]
+frequency=1440
+
+[store]
+name="local"
+path="/path/to/backups/folder"
+```
+
+As mentioned before, you could call `rireki add foobar` to create this file.
+
+## Development
+
+Run tests with `pytest` and lint your code with `flake8` (see the [Github Actions configuration](.github/workflows/testing.yml) for more details).

rireki-0.0.1/rireki/cli.py

@@ -0,0 +1,19 @@
+import click
+
+from rireki.commands.add import add
+from rireki.commands.backup import backup
+from rireki.commands.status import status
+from rireki.core.config import Config
+
+
+@click.group()
+def cli():
+    Config.load()
+
+
+cli.add_command(add)
+cli.add_command(backup)
+cli.add_command(status)
+
+if __name__ == '__main__':
+    cli()

rireki-0.0.1/rireki/commands/add.py

@@ -0,0 +1,73 @@
+import click
+
+from rireki.core.project import Project
+from rireki.core.projects_manager import ProjectsManager
+from rireki.drivers.index import drivers
+from rireki.stores.index import stores
+
+
+@click.command()
+@click.argument('name')
+@click.option('--driver', type=click.Choice(drivers.keys()), help='Backups driver')
+@click.option('--store', type=click.Choice(stores.keys()), help='Backups store')
+def add(name, driver=None, store=None):
+    """Install a new project"""
+
+    if ProjectsManager.project_exists(name):
+        click.echo('Project with name "%s" already installed!' % name)
+        return
+
+    driver = __resolve_driver(driver)
+    store = __resolve_store(store)
+
+    __add_new_project(name, driver, store)
+
+
+def __resolve_driver(driver):
+    if driver:
+        return driver
+
+    return click.prompt(
+        'Which driver would you like to use to backup this project?',
+        type=click.Choice(drivers.keys()),
+    )
+
+
+def __resolve_store(store):
+    if store:
+        return store
+
+    return click.prompt(
+        'Which store would you like to use to persist this project?',
+        type=click.Choice(stores.keys()),
+    )
+
+
+def __add_new_project(project_name, driver_name, store_name):
+    driver = __create_driver(driver_name)
+    store = __create_store(store_name)
+    project = __create_project(project_name, driver, store)
+
+    ProjectsManager.install_project(project)
+
+    click.echo('Project "%s" has been installed!' % project.name)
+
+
+def __create_driver(name):
+    driver = drivers[name]()
+
+    driver.ask_config()
+
+    return driver
+
+
+def __create_store(name):
+    store = stores[name]()
+
+    store.ask_config()
+
+    return store
+
+
+def __create_project(name, driver, store):
+    return Project(name, driver, store)

rireki-0.0.1/rireki/commands/status.py

@@ -0,0 +1,77 @@
+import click
+
+from rireki.core.projects_manager import ProjectsManager
+from rireki.utils.array_helpers import array_map
+from rireki.utils.output import display_table, format_time
+from rireki.utils.time_helpers import now
+
+
+@click.command()
+@click.argument('project', required=False)
+def status(project=None):
+    """Show status of installed projects"""
+
+    if project:
+        name = project
+        project = ProjectsManager.get_project_by_name(name)
+
+        if not project:
+            click.echo('Project with name "%s" is not installed!' % name)
+            return
+
+        __display_project_status(project)
+    else:
+        projects = ProjectsManager.get_projects()
+
+        __display_projects_status(projects)
+
+
+def __display_project_status(project):
+    if project.has_pending_backups():
+        click.echo(click.style('Project needs to be backed up', fg='red'))
+    else:
+        click.echo(
+            click.style('Project ', fg='green') +
+            click.style(project.name, bold=True, fg='green') +
+            click.style(' is up to date', fg='green'),
+        )
+
+    backups = project.get_backups()
+
+    click.echo('')
+    click.echo('All backups (%s):' % len(backups))
+
+    for backup in backups:
+        click.echo('- %s ago' % format_time(now() - backup.time, 'interval'))
+
+
+def __display_projects_status(projects):
+    if not projects:
+        click.echo('No projects installed!')
+        return
+
+    display_table(
+        ('Name', 'Driver', 'Store', 'Status'),
+        array_map(__get_project_info, projects),
+    )
+
+
+def __get_project_info(project):
+    if project.has_pending_backups():
+        status = {
+            'text': 'backup-pending',
+            'color': 'red',
+        }
+    else:
+        last_backup_interval = now() - project.get_last_backup().time
+        status = {
+            'text': 'Backed up %s ago' % format_time(last_backup_interval, 'interval'),
+            'color': 'green',
+        }
+
+    return (
+        project.name,
+        project.driver.name,
+        project.store.name,
+        status,
+    )

rireki-0.0.1/rireki.egg-info/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.1
+Name: rireki
+Version: 0.0.1
+Summary: CLI backup tool.
+Home-page: https://github.com/noeldemartin/rireki
+Author: Noel De Martin
+Author-email: noeldemartin@gmail.com
+License: MIT
+Description: # Rireki [![Github Actions Status](https://github.com/noeldemartin/rireki/workflows/Testing/badge.svg)](https://github.com/noeldemartin/rireki/actions)
+        
+        CLI backup tool.
+        
+        ## Installation
+        
+        Install the rireki cli running the following command:
+        
+        ```sh
+        pip install rireki
+        ```
+        
+        You need to call `rireki backup` in order for backups to be performed. For example, you could use the following crontab configuration to perform backup checks every hour (remember to create the `/var/log/rireki` directory as well):
+        
+        ```sh
+        0 * * * * rireki backup >> /var/log/rireki/cron.log 2>> /var/log/rireki/cron-error.log
+        ```
+        
+        ## Usage
+        
+        Get detailed information running `rireki --help`.
+        
+        There are three core concepts on how rireki manages backups:
+        
+        - **Projects:** A project is something you want to back up. For example a website database or a collection of files.
+        
+        - **Drivers:** A driver is the program used to create the backup files. For example zipping up a folder or dumping a database.
+        
+        - **Stores:** A store is the program used to save the backup files created with a driver. For example copying them to a local folder or uploading them to a 3rd party service.
+        
+        In order to install a new project to backup, a configuration file can be added to `~/.rireki/projects/{project-name}.conf`. This will be a [toml](https://github.com/toml-lang/toml) configuration file. It can either be created manually or calling `rireki add {project-name}`.
+        
+        ### Drivers
+        
+        #### Files
+        
+        This driver creates an archive with files copied from the local filesystem. The archive will be a zip file if possible or a tar file.
+        
+        It needs the following configuration:
+        
+        | property      | type          | description  |
+        | ------------- |---------------| -------------|
+        | name          | `"files"`     | The name of the driver. |
+        | frequency     | `integer`     | The frequency in seconds at which new backups should be made. |
+        | paths         | `string[]`    | Folders or files that will be included in the archive. |
+        
+        #### Custom
+        
+        This driver can be used if backing up a project is not supported by any of the other drivers. It consists of a custom script that will be called to generate the backup artifacts. The backup files should be placed on a path indicated by the `RIREKI_BACKUP_PATH` env variable.
+        
+        Once the script has completed, a file named `logs.json` will also be placed on the path with the standard output and standard error printed by the script.
+        
+        It needs the following configuration:
+        
+        | property      | type          | description  |
+        | ------------- |---------------| -------------|
+        | name          | `"custom"`    | The name of the driver. |
+        | frequency     | `integer`     | The frequency in seconds at which new backups should be made. |
+        | command       | `string`      | Command to call in order to perform backups. |
+        | timeout       | `integer`     | Number of seconds where the command will be timed out and the backup will fail. |
+        
+        ### Stores
+        
+        #### Local
+        
+        This store copies the backups to a folder in the same filesystem.
+        
+        It needs the following configuration:
+        
+        | property      | type          | description  |
+        | ------------- |---------------| -------------|
+        | name          | `"local"`     | The name of the store. |
+        | path          | `string`      | The path of the folder where the backups will be copied. |
+        
+        #### Amazon Web Services
+        
+        This store uploads the backups to an AWS S3 instance.
+        
+        It needs the following configuration:
+        
+        | property      | type          | description  |
+        | ------------- |---------------| -------------|
+        | name          | `"aws"`     | The name of the store. |
+        | region        | `string`      | The region where the S3 instance is located. |
+        | access_key    | `string`      | The access key ID. |
+        | access_secret | `string`      | The secret access key. |
+        | bucket        | `string`      | The name of the bucket where the files will be uploaded. |
+        | path          | `string`      | The path within the bucket where the files will be placed. |
+        
+        #### Digital Ocean
+        
+        This store uploads the backups to a Digital Ocean Spaces instance.
+        
+        It uses the same configuration as the AWS store, with the only exception that the name is `"digital-ocean"` instead.
+        
+        ### An example config file
+        
+        For example, to backup a project named "Foobar" using the `files` driver and the `local` store we would create the following file at `~/.rireki/projects/foobar.conf`:
+        
+        ```toml
+        name="foobar"
+        
+        [driver]
+        name="files"
+        paths=["/path/to/data/folder"]
+        frequency=1440
+        
+        [store]
+        name="local"
+        path="/path/to/backups/folder"
+        ```
+        
+        As mentioned before, you could call `rireki add foobar` to create this file.
+        
+        ## Development
+        
+        Run tests with `pytest` and lint your code with `flake8` (see the [Github Actions configuration](.github/workflows/testing.yml) for more details).
+        
+Platform: UNKNOWN
+Description-Content-Type: text/markdown

rireki-0.0.1/rireki.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+README.md
+setup.py
+rireki/__init__.py
+rireki/cli.py
+rireki.egg-info/PKG-INFO
+rireki.egg-info/SOURCES.txt
+rireki.egg-info/dependency_links.txt
+rireki.egg-info/entry_points.txt
+rireki.egg-info/requires.txt
+rireki.egg-info/top_level.txt
+rireki/commands/__init__.py
+rireki/commands/add.py
+rireki/commands/status.py

rireki-0.0.1/rireki.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

rireki-0.0.1/rireki.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+rireki = rireki.cli:cli
+

rireki-0.0.1/rireki.egg-info/requires.txt

@@ -0,0 +1,3 @@
+click
+toml
+boto3

rireki-0.0.1/rireki.egg-info/top_level.txt

@@ -0,0 +1 @@
+rireki

rireki-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

rireki-0.0.1/setup.py

@@ -0,0 +1,18 @@
+from setuptools import setup
+
+setup(
+    name='rireki',
+    version='0.0.1',
+    author='Noel De Martin',
+    author_email='noeldemartin@gmail.com',
+    description='CLI backup tool.',
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
+    url='https://github.com/noeldemartin/rireki',
+    license='MIT',
+    packages=['rireki'],
+    install_requires=['click', 'toml', 'boto3'],
+    entry_points={
+        'console_scripts': ['rireki = rireki.cli:cli'],
+    },
+)