summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorzlg <zlg@zlg.space>2018-10-10 20:49:02 -0700
committerzlg <zlg@zlg.space>2018-10-10 20:49:02 -0700
commit411e47351c996aa1d1f19dc10366ee824d091b40 (patch)
tree03626608293d8382c1c1cb43ed229ac0cfe7638c /src
parentcli: Add "import" command (diff)
downloadvgstash-411e47351c996aa1d1f19dc10366ee824d091b40.tar.gz
vgstash-411e47351c996aa1d1f19dc10366ee824d091b40.tar.bz2
vgstash-411e47351c996aa1d1f19dc10366ee824d091b40.tar.xz
vgstash-411e47351c996aa1d1f19dc10366ee824d091b40.zip
cli: Add "export" command
The export command is like the import command; currently supporting YAML output, but ready to be expanded as needed.
Diffstat (limited to '')
-rw-r--r--src/vgstash/test_vgstash_cli.py21
-rw-r--r--src/vgstash_cli.py38
2 files changed, 54 insertions, 5 deletions
diff --git a/src/vgstash/test_vgstash_cli.py b/src/vgstash/test_vgstash_cli.py
index 941179a..098c39e 100644
--- a/src/vgstash/test_vgstash_cli.py
+++ b/src/vgstash/test_vgstash_cli.py
@@ -6,6 +6,8 @@ import vgstash_cli
from click.testing import CliRunner
+# TODO: Setup a testing directory for test data and integrate with pytest
+
verbose = True
interactive = False
@@ -182,6 +184,7 @@ def test_update():
'The Legend | NES | D | P\n'
))
+
def test_notes():
runner = CliRunner()
result = runner.invoke(vgstash_cli.cli, ['notes', 'Vectorman 2', 'Genesis'])
@@ -195,6 +198,7 @@ def test_notes():
'boop\n'
))
+
def test_notes_edit():
if not interactive:
return
@@ -215,11 +219,11 @@ def test_notes_edit():
def test_import_file_yaml():
runner = CliRunner()
- result = runner.invoke(vgstash_cli.cli, ["import", "test.yml"])
+ result = runner.invoke(vgstash_cli.cli, ["import", "test_import.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"))
+ assert result.output == "Successfully imported 2 games from {}.\n".format(os.path.join(os.getcwd(), "test_import.yml"))
# List the results to make sure they match what the editor has.
list_runner = CliRunner()
@@ -231,11 +235,11 @@ def test_import_file_yaml():
def test_import_file_yaml_update():
runner = CliRunner()
- result = runner.invoke(vgstash_cli.cli, ["import", "test.yml", "-u"])
+ result = runner.invoke(vgstash_cli.cli, ["import", "test_import.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"))
+ assert result.output == "Successfully imported 3 games from {}.\n".format(os.path.join(os.getcwd(), "test_import.yml"))
# List the results to make sure they match what the editor has.
list_runner = CliRunner()
@@ -243,3 +247,12 @@ def test_import_file_yaml_update():
if verbose:
print(list_result.output)
assert list_result.exit_code == 0
+
+
+def test_export_file_yaml():
+ runner = CliRunner()
+ result = runner.invoke(vgstash_cli.cli, ["export", "-f", "yaml", "test_export.yml"])
+ if verbose:
+ print(result.output)
+ assert result.exit_code == 0
+ assert result.output == "Successfully exported 6 games to {}.\n".format(os.path.join(os.getcwd(), "test_export.yml"))
diff --git a/src/vgstash_cli.py b/src/vgstash_cli.py
index 5f69c47..72a751a 100644
--- a/src/vgstash_cli.py
+++ b/src/vgstash_cli.py
@@ -120,7 +120,6 @@ def list_games(filter, raw, width):
notes = notes.replace('\r', '\\r')
else:
notes = ''
-
if raw:
click.echo("|".join((
r['title'],
@@ -209,6 +208,7 @@ def notes(title, system, edit):
dir_okay=False,
file_okay=True),
default=sys.stdin,
+ required=False,
)
def import_file(format, filepath, update):
"""
@@ -236,3 +236,39 @@ def import_file(format, filepath, update):
except sqlite3.IntegrityError as e:
count -= 1
click.echo("Successfully imported {} games from {}.".format(count, filepath))
+
+
+@cli.command("export")
+@click.option("--format", "-f", type=click.Choice(["yaml"]), required=False, default="yaml")
+@click.argument("filepath",
+ type=click.Path(
+ exists=False,
+ readable=True,
+ writable=True,
+ resolve_path=True,
+ dir_okay=False,
+ file_okay=True),
+ default=sys.stdout,
+ required=False,
+ )
+def export_file(format, filepath):
+ """
+ Export the game database to a file written in the chosen format.
+
+ The default format is YAML.
+ """
+ db = get_db()
+ data = db.list_games()
+ game_set = []
+ # Time to re-read master's code
+ if format == "yaml":
+ for game in data:
+ g = {}
+ for field in game.keys():
+ g.update({field: game[field]})
+ game_set.append(g)
+ with open(filepath, "w") as fp:
+ yaml.dump(game_set, fp, default_flow_style=False,
+ indent=4, allow_unicode=True)
+ click.echo("Successfully exported 6 games to {}.".format(os.path.join(os.getcwd(), "test_export.yml")))
+
atabase already uses a game's title and system as the primary keys. Row IDs are redundant. 2018-10-06cli: change "Status" heading to "Progress"zlg2-36/+40 2018-09-29Bump to 0.3alpha5 for PyPIzlg1-1/+1 2018-09-29cli: Add pretty printing to 'list' commandzlg3-17/+107 Also add the "--width" option to specify the maximum width of the table. 2018-09-08setup.py: Bump to alpha4 for PyPIzlg1-1/+1 2018-09-08cli: add '--raw' option to list commandzlg2-9/+45 Add '--raw' option to the list command, in addition to proper note expansion. Newline characters in notes are escaped to be friendly to scripting. This option may be shortened to '-r' at the user's convenience. In raw output mode, the information is formatted in plain pipe-delimited strings, one line per row: title|system|ownership|progress|notes ownership and progress are printed in their numeric form, consistent with the OWNERSHIP and PROGRESS dictionaries in the vgstash package. An empty notes field will result in a line ending with a pipe and no whitespace following it. 2018-09-08Add remaining filters to vgstash packagezlg1-2/+11 2018-09-04Update LICENSE to match setup.pyzlg1-80/+67 Whoops. 2018-09-03Branch off from master with pytest, tox, clickzlg16-778/+779 This commit is huge, but contains everything needed for a "proper" build system built on pytest + tox and a CLI built with click. For now, this branch will contain all new vgstash development activity until it reaches feature parity with master. The CLI is installed to pip's PATH. Only the 'init', 'add', and 'list' commands work, with only two filters. This is pre-alpha software, and is therefore not stable yet. 2018-03-18Flesh out filter types and ownership statuszlg3-82/+144 It's time for a refactor to a module; the functionality and interface are clashing. 2018-03-18README.mdown: break line correctlyzlg1-1/+1 2018-03-18add 'playlog' list filterzlg2-2/+9 This filter is used to get an idea of which games you're currently playing through, so you can prioritize games to play when you're bored and detect it when you've beaten a game but haven't marked it as such. 2018-03-13Update helpers a bitzlg1-2/+9 At present, user modification is needed to make these seamless. vgup() may need to be axed in favor of telling the user to make an alias. 2018-03-13Make VGSTASH_DB_LOCATION point to a filezlg2-21/+20 It used to point to a directory, which would then look for .vgstash.db. This behavior was kind of backwards and I don't remember why I did it that way. This change gives users more control over where they put their DB. Be sure to update your environment variable if you have it set! 2016-11-18Remove settings from helpers.shZe Libertine Gamer1-5/+0 Sourcing them in .bash_profile screws up login if they're set. 2016-11-15Correct phrasing in README.Ze Libertine Gamer1-4/+4 2016-11-13DerpZe Libertine Gamer1-0/+1 2016-11-03Improve error handling in shell scriptsZe Libertine Gamer4-3/+23 2016-10-24Correct run_again, add recursionZe Libertine Gamer1-0/+4 Loops and functions -- oh my, what a useful combination. :) 2016-10-21Add quotes to correct behavior for arglistZe Libertine Gamer1-1/+1 2016-10-14updater.sh: add recursion, error handlingZe Libertine Gamer1-43/+101 2016-10-14Correct pipe-handling behaviorZe Libertine Gamer1-1/+9 2016-10-12Clarify a method to move between platformsZe Libertine Gamer1-2/+5 Also correct a typo.