rewriting with better type safety

Author: NonLogicalDev

.gitignore

@@ -1,4 +1,5 @@
 .idea
+.vscode
 
 # Created by https://www.gitignore.io/api/python,vim,intellij
 # Edit at https://www.gitignore.io/?templates=python,vim,intellij

Makefile

@@ -1,3 +1,25 @@
+export TWINE_USERNAME=nonlogicaldev
+
+.PHONY: install
 install:
-	pip install -r requirements.txt
-	python setup.py install
+	pip install -e .
+
+.PHONY: deps
+deps:
+	pipenv sync
+
+.PHONY: dist
+dist:
+	pipenv run python3 setup.py sdist
+
+.PHONY: clean
+clean:
+	-rm -rf build
+	-rm -rf dist
+	-rm -rf *.egg-info
+
+pip.release: clean dist
+	pipenv run twine upload --repository testpypi dist/*
+
+pip.release.prod: clean dist
+	pipenv run twine upload dist/*

Pipfile

@@ -1,15 +1,16 @@
+[requires]
+python_version = "3"
+
+[script]
+dotter = "python bin/dotter"
+
 [[source]]
 name = "pypi"
 url = "https://pypi.org/simple"
 verify_ssl = true
 
 [dev-packages]
-
-[script]
-dotter = "python bin/dotter"
-
-[requires]
-python_version = "3.7"
+twine = "*"
 
 [packages]
 dotter = {editable = true,path = "."}

Pipfile.lock

@@ -13,26 +13,21 @@ dotter link
 ## Usage Output:
 
 ### Root Command:
-```
-usage: dotter [-h] [--root ROOT_DIR] [--conf-dir CONF_DIR]
-              {config,link,query,root} ...
 
-A dotfile linker.
+```
+usage: dotter [-h] {version,link,config} ...
 
-This utility creates a link farm from a data root to users home directory. 
+A dotfile linker. This utility creates a link farm from a data root to users home directory.
 It's intended use is to keep dotfiles neatly organized and separated by topics.
 
-Following ENV variables control the default behaviour:
-DOTTER_CONFIG_ROOT: Configuration root (where dotfiles live).
-DOTTER_OUTPUT_ROOT: Output root where the files will be linked to.
-
-positional arguments:
-  {config,link,query,root}
-
 optional arguments:
   -h, --help            show this help message and exit
-  --root ROOT_DIR       Alternative root location (for testing configuration)
-  --conf-dir CONF_DIR   Alternative configuration location (for testing configuration)
+
+command:
+  {version,link,config}
+    version             print version and exit
+    link                link dotfiles from $HOME/.config/dotter
+    config              query configuration values
 ```
 
 ### Link Command:

README.md

@@ -2,26 +2,28 @@
 # -*- coding: utf-8 -*-
 
 import sys
-import dotter
 import argparse
 import logging
 
+from dotter import App, SyncError
 
-log = logging.getLogger()
-log.addHandler(logging.StreamHandler(stream=sys.stderr))
-log.setLevel("DEBUG")
+__description__ = """
+A dotfile linker.
 
+This utility creates a link farm from a data root to users home directory.
+It's intended use is to keep dotfiles neatly organized and separated by topics.
+"""
 
 def main():
-    parser = argparse.ArgumentParser(prog='dotter')
-
-    script = dotter.App(parser)
-
+    parser = argparse.ArgumentParser(
+        prog='dotter',
+        description=__description__,
+    )
     try:
-        return script.run(parser, parser.parse_args())
+        return App.run(parser)
     except KeyboardInterrupt:
         return 1
-    except Exception as e:
+    except SyncError as e:
         parser.error(str(e))
         return 130