cli: Add "import" command

Currently the import command will only accept YAML files, but is ready
for expansion to other formats as needed.

5 files changed, 76 insertions, 1 deletions

diff --git a/MANIFEST.in b/MANIFEST.in
index b44eea6..140b2bc 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,3 +1,4 @@
 include AUTHORS
 include LICENSE
 include README.md
+include requirements.txt
diff --git a/requirements.txt b/requirements.txt
index 7df6387..bc0dfb0 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,2 +1,3 @@
 Click
 pytest
+PyYAML
diff --git a/setup.py b/setup.py
index 5910ab6..f2f16d1 100755
--- a/setup.py
+++ b/setup.py
@@ -28,6 +28,7 @@ setup(
     },
     install_requires=[
         'Click>=6.0', # for better Windows console support
+        'PyYAML', # importing from YAML files
     ],
     #py_modules=["vgstash"],
     classifiers=(
diff --git a/src/vgstash/test_vgstash_cli.py b/src/vgstash/test_vgstash_cli.py
index ecb23c1..941179a 100644
--- a/src/vgstash/test_vgstash_cli.py
+++ b/src/vgstash/test_vgstash_cli.py
@@ -6,7 +6,7 @@ import vgstash_cli
 
 from click.testing import CliRunner
 
-verbose = False
+verbose = True
 interactive = False
 
 # Change this to suit your testing environment
@@ -211,3 +211,35 @@ def test_notes_edit():
     if verbose:
         print(list_result.output)
     assert list_result.exit_code == 0
+
+
+def test_import_file_yaml():
+    runner = CliRunner()
+    result = runner.invoke(vgstash_cli.cli, ["import", "test.yml"])
+    if verbose:
+        print(result.output)
+    assert result.exit_code == 0
+    assert result.output == "Successfully imported 2 games from {}.\n".format(os.path.join(os.getcwd(), "test.yml"))
+
+    # List the results to make sure they match what the editor has.
+    list_runner = CliRunner()
+    list_result = runner.invoke(vgstash_cli.cli, ['list', '-w', '40'])
+    if verbose:
+        print(list_result.output)
+    assert list_result.exit_code == 0
+
+
+def test_import_file_yaml_update():
+    runner = CliRunner()
+    result = runner.invoke(vgstash_cli.cli, ["import", "test.yml", "-u"])
+    if verbose:
+        print(result.output)
+    assert result.exit_code == 0
+    assert result.output == "Successfully imported 3 games from {}.\n".format(os.path.join(os.getcwd(), "test.yml"))
+
+    # List the results to make sure they match what the editor has.
+    list_runner = CliRunner()
+    list_result = runner.invoke(vgstash_cli.cli, ['list', '-w', '40'])
+    if verbose:
+        print(list_result.output)
+    assert list_result.exit_code == 0
diff --git a/src/vgstash_cli.py b/src/vgstash_cli.py
index 6289dba..5f69c47 100644
--- a/src/vgstash_cli.py
+++ b/src/vgstash_cli.py
@@ -5,6 +5,7 @@ import os
 import subprocess
 import sys
 import tempfile
+import yaml
 
 # Click also has this, but it doesn't support a fallback value.
 from shutil import get_terminal_size
@@ -196,3 +197,42 @@ def notes(title, system, edit):
         click.echo("Notes for {} on {}:".format(target_game.title, target_game.system))
         click.echo()
         click.echo(target_game.notes)
+
+
+@cli.command("import")
+@click.option("--format", "-f", type=click.Choice(["yaml"]), required=False, default="yaml")
+@click.option("--update", "-u", is_flag=True, default=False, help="Overwrite existing games with the file's data")
+@click.argument("filepath",
+                type=click.Path(
+                    readable=True,
+                    resolve_path=True,
+                    dir_okay=False,
+                    file_okay=True),
+                default=sys.stdin,
+                )
+def import_file(format, filepath, update):
+    """
+    Import game data from an external file matching the chosen format.
+
+    The default format is YAML.
+    """
+    if format == "yaml":
+        with open(filepath) as fp:
+            data = yaml.safe_load(fp)
+        db = get_db()
+        count = len(data)
+        for game in data:
+            try:
+                db.add_game(
+                    vgstash.Game(
+                        game["title"],
+                        game["system"],
+                        game["ownership"],
+                        game["progress"],
+                        game["notes"]
+                    ),
+                    update=update
+                )
+            except sqlite3.IntegrityError as e:
+                count -= 1
+        click.echo("Successfully imported {} games from {}.".format(count, filepath))