Refactored packaging to make the project more pythonic

sdj0 · Feb 23, 2018 · c90708d · c90708d
1 parent ec58a97
commit c90708d
Show file tree

Hide file tree

Showing 22 changed files with 39 additions and 43 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1 +1 @@
-include schema/base_schema.json
+include fire/schema/base_schema.json
diff --git a/bin/fire-1099 b/bin/fire-1099
@@ -0,0 +1,7 @@
+"""
+Main entrypoint
+"""
+
+from fire.translator import cli
+
+cli()
diff --git a/entities/__init__.py → fire/__init__.py b/entities/__init__.py → fire/__init__.py
diff --git a/schema/__init__.py → fire/entities/__init__.py b/schema/__init__.py → fire/entities/__init__.py
diff --git a/entities/end_of_payer.py → fire/entities/end_of_payer.py b/entities/end_of_payer.py → fire/entities/end_of_payer.py
@@ -5,8 +5,8 @@
 """
 from itertools import chain
 
-from translator.util import rjust_zero
-from translator.util import factor_transforms, xform_entity, fire_entity
+from fire.translator.util import rjust_zero
+from fire.translator.util import factor_transforms, xform_entity, fire_entity
 
 """
 _END_OF_PAYER_TRANSFORMS

diff --git a/entities/end_of_transmission.py → fire/entities/end_of_transmission.py b/entities/end_of_transmission.py → fire/entities/end_of_transmission.py
@@ -3,8 +3,8 @@
 Representation of an "end_of_transmission" record, including transformation
 functions and support functions for conversion into different formats.
 """
-from translator.util import rjust_zero
-from translator.util import factor_transforms, xform_entity, fire_entity
+from fire.translator.util import rjust_zero
+from fire.translator.util import factor_transforms, xform_entity, fire_entity
 
 """
 _END_OF_TRANSMISSION_TRANSFORMS

diff --git a/entities/extension_of_time.py → fire/entities/extension_of_time.py b/entities/extension_of_time.py → fire/entities/extension_of_time.py
@@ -3,8 +3,8 @@
 Representation of a "extension_of_time" record, including transformation
 functions and support functions for conversion into different formats.
 """
-from translator.util import digits_only, uppercase
-from translator.util import factor_transforms, xform_entity, fire_entity
+from fire.translator.util import digits_only, uppercase
+from fire.translator.util import factor_transforms, xform_entity, fire_entity
 
 """
 EXTENSION_OF_TIME_TRANSFORMS

diff --git a/entities/payees.py → fire/entities/payees.py b/entities/payees.py → fire/entities/payees.py
@@ -8,8 +8,8 @@
 """
 from itertools import chain
 
-from translator.util import digits_only, uppercase, rjust_zero
-from translator.util import factor_transforms, xform_entity, fire_entity
+from fire.translator.util import digits_only, uppercase, rjust_zero
+from fire.translator.util import factor_transforms, xform_entity, fire_entity
 """
 _PAYEE_TRANSFORMS
 -----------------------

diff --git a/entities/payer.py → fire/entities/payer.py b/entities/payer.py → fire/entities/payer.py
@@ -3,8 +3,8 @@
 Representation of a "payer" record, including transformation functions
 and support functions for conversion into different formats.
 """
-from translator.util import digits_only, uppercase, rjust_zero
-from translator.util import factor_transforms, xform_entity, fire_entity
+from fire.translator.util import digits_only, uppercase, rjust_zero
+from fire.translator.util import factor_transforms, xform_entity, fire_entity
 
 """
 _PAYER_TRANSFORMS

diff --git a/entities/transmitter.py → fire/entities/transmitter.py b/entities/transmitter.py → fire/entities/transmitter.py
@@ -4,8 +4,8 @@
 Representation of a "transmitter" record, including transformation functions
 and support functions for conversion into different formats.
 """
-from translator.util import digits_only, uppercase, rjust_zero
-from translator.util import factor_transforms, xform_entity, fire_entity
+from fire.translator.util import digits_only, uppercase, rjust_zero
+from fire.translator.util import factor_transforms, xform_entity, fire_entity
 
 """
 _TRANSMITTER_TRANSFORMS

diff --git a/translator/__init__.py → fire/schema/__init__.py b/translator/__init__.py → fire/schema/__init__.py
diff --git a/schema/base_schema.json → fire/schema/base_schema.json b/schema/base_schema.json → fire/schema/base_schema.json
diff --git a/fire/translator/__init__.py b/fire/translator/__init__.py
@@ -0,0 +1,5 @@
+"""
+Module entrypoint
+"""
+
+from .translator import cli
diff --git a/translator/translator.py → fire/translator/translator.py b/translator/translator.py → fire/translator/translator.py
@@ -13,25 +13,20 @@
 from jsonschema import validate
 import click
 
-from translator.util import SequenceGenerator
-from entities import transmitter, payer, payees, end_of_payer, \
-                     end_of_transmission
+from fire.entities import transmitter, payer, payees, end_of_payer, \
+                          end_of_transmission
+from .util import SequenceGenerator
 
 @click.command()
 @click.argument('input_path', type=click.Path(exists=True))
-@click.option('--output', type=click.Path())
-
+@click.option('--output', type=click.Path(),
+              help='system path for the output to be generated')
 def cli(input_path, output):
     """
-    Wrapper and entry point for command line interface.
-
-    Parameters
-    ----------
-    input_path : str
-        system path for file containing the user input JSON data
-    output : str
-        optional system path for the output to be generated
+    Convert a JSON input file into the format required by IRS Publication 1220
 
+    \b
+    input_path: system path for file containing the user input JSON data
     """
     run(input_path, output)
 

diff --git a/translator/util.py → fire/translator/util.py b/translator/util.py → fire/translator/util.py
diff --git a/setup.py b/setup.py
@@ -21,10 +21,7 @@
     packages=find_packages(exclude=['contrib', 'docs', 'tests*', 'spec*']),
     include_package_data=True,
     install_requires=['click', 'jsonschema'],
-    entry_points = '''
-        [console_scripts]
-        fire-1099 = translator.translator:cli
-    ''',
+    scripts=['bin/fire-1099'],
 
     classifiers=[
         'Development Status :: 4 - Alpha',

diff --git a/spec/spec_util.py b/spec/spec_util.py
@@ -13,7 +13,7 @@
 from jsonschema import validate
 from nose.tools import raises
 
-SCHEMA = json.load(open("./schema/base_schema.json"))
+SCHEMA = json.load(open("./fire/schema/base_schema.json"))
 VALID_ALL_PATH = "./spec/data/valid_all.json"
 INVALID_PHONE_NUMS = ["+1 555 666 7777", "555 A44 B777", "123ABC5678",
                       "123 45 67", "555 666 777788", "555 666 7777 #"]

diff --git a/spec/test_entity_payee.py b/spec/test_entity_payee.py
@@ -16,7 +16,7 @@
                       VALID_TINS, INVALID_TINS, VALID_ZIPS, INVALID_ZIPS, \
                       PAYEE_BLANK_MAP, VALID_DOLLAR_AMOUNTS, \
                       INVALID_DOLLAR_AMOUNTS
-from entities import payees
+from fire.entities import payees
 
 VALID_PAYEE = []
 VALID_PAYEE = VALID_ALL_DATA["payees"]

diff --git a/spec/test_entity_payer.py b/spec/test_entity_payer.py
@@ -13,7 +13,7 @@
                       SCHEMA, PAYER_BLANK_MAP, VALID_ALL_DATA, \
                       VALID_PHONE_NUMS, VALID_ZIPS, INVALID_ZIPS, \
                       INVALID_PHONE_NUMS, VALID_TINS, INVALID_TINS
-from entities import payer
+from fire.entities import payer
 
 VALID_PAYER = {}
 VALID_PAYER["payer"] = VALID_ALL_DATA["payer"]

diff --git a/spec/test_entity_transmitter.py b/spec/test_entity_transmitter.py
@@ -15,7 +15,7 @@
                       VALID_PHONE_NUMS, VALID_ZIPS, INVALID_ZIPS, \
                       VALID_EMAILS, INVALID_EMAILS, INVALID_PHONE_NUMS, \
                       VALID_TINS, INVALID_TINS
-from entities import transmitter
+from fire.entities import transmitter
 
 VALID_TRANSMITTER = {}
 VALID_TRANSMITTER["transmitter"] = VALID_ALL_DATA["transmitter"]

diff --git a/spec/test_translator.py b/spec/test_translator.py
@@ -12,7 +12,7 @@
                       END_OF_PAYER_BLANK_MAP, END_OF_TRANSMISSION_BLANK_MAP, \
                       TRANSMITTER_BLANK_MAP, VALID_ALL_DATA, \
                       VALID_ALL_PATH
-from translator import translator
+from fire.translator import translator
 
 # Tests whether a correct input file generates a correct output file
 # Tests whether an output file is defaulted if no path is given

diff --git a/translator/__main__.py b/translator/__main__.py
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		include schema/base_schema.json
		include fire/schema/base_schema.json