Merge pull request #13 from siemens/feat/cli/new-name

feat(cli): Change app name to snap2bucket

.github/workflows/docs.yml

@@ -11,7 +11,7 @@ jobs:
       image: python:3.8-slim
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
       - name: Install host dependencies
         run: |
           apt-get -qq update

.github/workflows/lint.yml

@@ -10,18 +10,21 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python 3.9
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: 3.9
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        pip install pylint pipenv
+        pipx install pylint
+        pipx install pipenv
     - name: Install package
       run: |
         pipenv install --dev --editable .
     - name: Analysing the code with pylint
       run: |
         pipenv run pylint src/snap_to_bucket
+    - name: Check package
+      run: |
+        pipenv run check_package

.github/workflows/release-publish.yml

@@ -0,0 +1,37 @@
+name: Publish Release Packages
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  release:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.8'
+          architecture: 'x64'
+
+      - name: Install build dependencies
+        run: |
+          pipx install pipenv
+          pipenv install
+
+      - name: Check package
+        run: pipenv run check_package
+
+      - name: Build packages
+        run: pipenv run build_packages
+
+      - name: Upload Packages to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -12,3 +12,4 @@ tags
 *__pycache__/
 build
 *.egg-info
+dist

Pipfile

@@ -13,3 +13,7 @@ snap-to-bucket = {path = "."}
 sphinx = "*"
 snap-to-bucket = {editable = true, path = "."}
 pylint = "*"
+
+[scripts]
+build_packages = "python3 ./setup.py sdist bdist_wheel"
+check_package = "python3 ./setup.py check"

README.md

@@ -1,16 +1,25 @@
 # snap_to_bucket
 
 ![snap_to_bucket docs](https://github.com/siemens/snap-to-bucket/workflows/snap_to_bucket%20docs/badge.svg)
+[![PyPI version](https://badge.fury.io/py/snap-to-bucket.svg)](https://badge.fury.io/py/snap-to-bucket)
 
 This tool allows to move data from AWS snapshots to S3 buckets.
 
 ### Installation
 
+#### Local installation
 ```console
+$ git clone https://github.com/siemens/snap-to-bucket.git
+$ cd snap-to-bucket
 $ python3 -m pip install -U pipenv
 $ pipenv install --dev --editable .
 ```
 
+#### PyPi
+```console
+$ python3 -m pip install -U snap-to-bucket
+```
+
 ### Requirements
 
 1. The script needs to be running on an EC2 instance.
@@ -95,11 +104,11 @@ script needs to mount/unmount volumes.
 
 - Runing from source
 ```console
-# pipenv run snap_to_bucket --bucket <bucket>
+# pipenv run snap2bucket --bucket <bucket>
 ```
 - Runing from install
 ```console
-# snap_to_bucket --bucket <bucket>
+# snap2bucket --bucket <bucket>
 ```
 
 If you have used different tags on snapshots, use `-t\--tag` option.
@@ -133,10 +142,9 @@ Since the S3 has a limit on object size, a single split can not be larger than
 ### Options
 
 ```
-Usage: snap_to_bucket [OPTIONS]
+Usage: snap2bucket [OPTIONS]
 
-  snap_to_bucket is a simple tool based on boto3 to move snapshots to S3
-  buckets.
+  snap2bucket is a simple tool based on boto3 to move snapshots to S3 buckets.
 
 Options:
   --version                       Show the version and exit.
@@ -239,11 +247,11 @@ for i in /sys /proc /run /dev; do sudo umount /mnt/snapshot$i; done
 Run the script with `-r\--restore` flag and provide the bucket and the key.
 - Runing from source
 ```console
-# pipenv run snap_to_bucket --restore --bucket <bucket> --key <key>
+# pipenv run snap2bucket --restore --bucket <bucket> --key <key>
 ```
 - Runing from install
 ```console
-# snap_to_bucket --restore --bucket <bucket> --key <key>
+# snap2bucket --restore --bucket <bucket> --key <key>
 ```
 
 **Note:** The script will create new volume of size 25% more than the size of

doc-sources/conf.py

@@ -25,11 +25,11 @@
 # -- Project information -----------------------------------------------------
 
 project = 'snap_to_bucket'
-copyright = '2020-2021, Siemens AG'
+copyright = '2020-2022, Siemens AG'
 author = 'Gaurav Mishra <mishra.gaurav@siemens.com>'
 
 # The full version, including alpha/beta/rc tags
-release = '1.0.1'
+release = '1.0.4'
 
 
 # -- General configuration ---------------------------------------------------

doc-sources/index.rst

@@ -11,11 +11,20 @@ This tool allows to move data from AWS snapshots to S3 buckets.
 Installation
 =======================
 
+* From source code
+
 .. code-block:: bash
 
+    $ git clone https://github.com/siemens/snap-to-bucket.git
+    $ cd snap-to-bucket
     $ python3 -m pip install -U pipenv
     $ pipenv install --dev --editable .
 
+* From PyPi
+
+.. code-block:: bash
+    $ python3 -m pip install -U snap-to-bucket
+
 Requirements
 ===============
 
@@ -95,10 +104,9 @@ Options
 
 .. code-block::
 
-    Usage: snap_to_bucket [OPTIONS]
+    Usage: snap2bucket [OPTIONS]
 
-      snap_to_bucket is a simple tool based on boto3 to move snapshots to S3
-      buckets.
+      snap2bucket is a simple tool based on boto3 to move snapshots to S3 buckets.
 
     Options:
       --version                       Show the version and exit.

doc-sources/recovery.rst

@@ -60,13 +60,13 @@ Run the script with ``-r\--restore`` flag and provide the bucket and the key.
 
 .. code-block:: bash
 
-    pipenv run snap_to_bucket --restore --bucket <bucket> --key <key>
+    pipenv run snap2bucket --restore --bucket <bucket> --key <key>
 
 * Runing from install
 
 .. code-block:: bash
 
-    snap_to_bucket --restore --bucket <bucket> --key <key>
+    snap2bucket --restore --bucket <bucket> --key <key>
 
 **Note:** The script will create new volume of size 25% more than the size of
 tar or ``x-amz-meta-disc-size`` metadata (if available).

doc-sources/setupmigrate.rst

@@ -26,13 +26,13 @@ script needs to mount/unmount volumes.
 
 .. code-block:: bash
 
-    pipenv run snap_to_bucket --bucket <bucket>
+    pipenv run snap2bucket --bucket <bucket>
 
 * Runing from install
 
 .. code-block:: bash
 
-    snap_to_bucket --bucket <bucket>
+    snap2bucket --bucket <bucket>
 
 If you have used different tags on snapshots, use ``-t/--tag`` option.
 

setup.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-SPDX-FileCopyrightText: Siemens AG, 2020-2021 Gaurav Mishra <mishra.gaurav@siemens.com>
+SPDX-FileCopyrightText: Siemens AG, 2020-2022 Gaurav Mishra <mishra.gaurav@siemens.com>
 
 SPDX-License-Identifier: MIT
 """
@@ -32,7 +32,7 @@ def read(fname):
 
 metadata = dict(
     name="snap_to_bucket",
-    version="1.0.2",
+    version="1.0.4",
     author="Gaurav Mishra",
     author_email="mishra.gaurav@siemens.com",
     description=("Move AWS EBS Snapshots to S3 Buckets"),
@@ -65,7 +65,7 @@ def read(fname):
     ],
     entry_points = {
         'console_scripts': [
-            'snap_to_bucket = snap_to_bucket.run:main'
+            'snap2bucket = snap_to_bucket.run:main'
         ]
     },
 )

src/snap_to_bucket/__init__.py

@@ -7,8 +7,3 @@
 SPDX-License-Identifier: MIT
 """
 __author__ = 'Siemens AG'
-
-from .ec_2_handler import Ec2Handler
-from .fs_handler import FsHandler
-from .s3_handler import S3Handler
-from .snap_handler import SnapToBucket

src/snap_to_bucket/handlers/__init__.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+SPDX-FileCopyrightText: Siemens AG, 2022 Gaurav Mishra <mishra.gaurav@siemens.com>
+
+SPDX-License-Identifier: MIT
+"""
+__author__ = 'Siemens AG'
+
+from .ec_2_handler import Ec2Handler
+from .s3_handler import S3Handler
+from .fs_handler import FsHandler

src/snap_to_bucket/s3_handler.py → src/snap_to_bucket/handlers/s3_handler.py

@@ -137,7 +137,7 @@ def __get_object_count(self, key):
                 partition_size = int(
                     response["Metadata"]["x-amz-meta-disc-size"])
             if partition_size < 2:
-                partition_size = sum([int(o["Size"]) for o in objects])
+                partition_size = sum((int(o["Size"]) for o in objects))
             self.restore_partition_size = partition_size
             return len(objects)
         except Exception as ex:

src/snap_to_bucket/run.py

@@ -16,7 +16,7 @@
 import click
 from pkg_resources import get_distribution
 
-from snap_to_bucket import SnapToBucket
+from snap_to_bucket.runner import SnapToBucket
 
 
 class VolSize(click.ParamType):
@@ -122,7 +122,7 @@ def main(verbose, proxy, noproxy, bucket, tag, type, storage_class, mount,
          delete, split, gzip, restore, key, boot, restore_dir, iops,
          throughput):
     """
-    snap_to_bucket is a simple tool based on boto3 to move snapshots to S3
+    snap2bucket is a simple tool based on boto3 to move snapshots to S3
     buckets.
     """
     if type not in ["gp3", "io1", "io2"] and iops is not None:

src/snap_to_bucket/runner/__init__.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+SPDX-FileCopyrightText: Siemens AG, 2022 Gaurav Mishra <mishra.gaurav@siemens.com>
+
+SPDX-License-Identifier: MIT
+"""
+__author__ = 'Siemens AG'
+
+from .snap_handler import SnapToBucket

src/snap_to_bucket/snap_handler.py → src/snap_to_bucket/runner/snap_handler.py

@@ -11,9 +11,9 @@
 import os
 import sys
 
-from snap_to_bucket import Ec2Handler
-from snap_to_bucket import S3Handler
-from snap_to_bucket import FsHandler
+from snap_to_bucket.handlers import Ec2Handler
+from snap_to_bucket.handlers import S3Handler
+from snap_to_bucket.handlers import FsHandler
 
 
 class SnapToBucket: