Updated setup and README

cfpb · ee22d55e180393461dc78a429362b58a4162fc61 · cndreisbach committed Feb 16, 2013 · Feb 16, 2013 · ee22d55
1 parent 7da576e
commit ee22d55e180393461dc78a429362b58a4162fc61
Unified Split

Showing with 51 additions and 44 deletions.

+0 −33 README.md

+41 −0 README.rst

+10 −11 setup.py
diff --git a/README.md b/README.md
@@ -1,33 +0,0 @@
-hmda-tools
-==========
-
-Tools to make analyzing HMDA data much easier.
-
-* `bin/`: Scripts to load data.  
-  * `bin/hmda_create_schemas`: Create the schema needed for HMDA data.
-  * `bin/hmda_load_code_sheet`: Load all the data from the HMDA code sheet.
-  * `bin/hmda_load_cbsa`: Download and load the Dec 2009 CBSA data, allowing you to the `msa_md` column from HMDA with a Metropolitian Statistical Area (MSA).
-  * `bin/hmda_load_geo`: Download and load the 2010 Census Gazetteer data, allowing you to associate state and county FIPS codes from HMDA to names and demographic data.
-  
-## HMDA
-
-"HMDA" refers to the [Home Mortgage Disclosure Act][hmda], a law that
-requires financial institutions to maintain and annually disclose data
-about home purchases, home purchase pre-approvals, home improvement,
-and refinance applications. This data is made public and is available
-from the US Government at the [FFIEC HMDA Products][hmda-products]
-site.
-
-[hmda]: http://en.wikipedia.org/wiki/Home_Mortgage_Disclosure_Act
-[hmda-products]: http://www.ffiec.gov/hmda/hmdaproducts.htm
-  
-## How to download and load HMDA data
-
-The following commands will load the 2011 HMDA data into MySQL. Please feel free to contribute a better automated way to work with multiple DBs.
-
-```sh
-wget http://www.ffiec.gov/hmdarawdata/LAR/National/2011HMDALAR%20-%20National.zip -O hmda11.zip
-unzip -p hmda11.zip | sed 's/NA//g' | sed 's/ //g' > hmd11c.csv
-mysql -e 'load data local infile 'hmda11c.csv' into table hmda fields terminated by ',' lines terminated by "\n";'
-```
-
diff --git a/README.rst b/README.rst
@@ -0,0 +1,41 @@
+hmda-tools
+==========
+
+Tools to make analyzing HMDA data much easier.
+
+HMDA
+----
+
+"HMDA" refers to the `Home Mortgage Disclosure Act`_, a law that requires
+financial institutions to maintain and annually disclose data about home
+purchases, home purchase pre-approvals, home improvement, and refinance applications. This data is made public and is available from the US Government at the `FFIEC HMDA Products`_ site.
+
+.. _Home Mortgage Disclosure Act:  http://en.wikipedia.org/wiki/Home_Mortgage_Disclosure_Act
+.. _FFIEC HMDA Products: http://www.ffiec.gov/hmda/hmdaproducts.htm
+
+Included scripts
+----------------
+
+-  ``bin/hmda_create_schemas``: Create the schema needed for HMDA data.
+-  ``bin/hmda_load_code_sheet``: Load all the data from the HMDA code
+   sheet.
+-  ``bin/hmda_load_cbsa``: Download and load the Dec 2009 CBSA data,
+   allowing you to the ``msa_md`` column from HMDA with a Metropolitian
+   Statistical Area (MSA).
+-  ``bin/hmda_load_geo``: Download and load the 2010 Census Gazetteer
+   data, allowing you to associate state and county FIPS codes from HMDA
+   to names and demographic data.
+
+How to download and load HMDA data
+----------------------------------
+
+The following commands will load the 2011 HMDA data into MySQL. Please
+feel free to contribute a better automated way to work with multiple
+DBs.
+
+::
+
+    wget http://www.ffiec.gov/hmdarawdata/LAR/National/2011HMDALAR%20-%20National.zip -O hmda11.zip
+    unzip -p hmda11.zip | sed 's/NA//g' | sed 's/ //g' > hmd11c.csv
+    mysql -e 'load data local infile 'hmda11c.csv' into table hmda fields terminated by ',' lines terminated by "\n";'
+
diff --git a/setup.py b/setup.py
@@ -6,26 +6,25 @@ def readme():
     with open('README.md') as f:
         return f.read()
 
-setup(name='hmda_tools',
+def requirements():
+    with open('requirements.txt') as f:
+        return map(lambda x: x.strip(), f.readlines())
+
+setup(name='hmda-tools',
       version='0.1',
       description='Tools to make working with HMDA data easier.',
       long_description=readme(),
-      url='http://github.com/crnixon/hmda_tools',
+      url='http://github.com/cfpb/hmda-tools',
       author='Clinton Dreisbach and others',
-      author_email='clinton@dreisbach.us',
-      license='Apache 2.0',
+      author_email='clinton.dreisbach@cfpb.gov',
+      license='Public domain',
       packages=['hmda_tools'],
-      install_requires=[
-        'sqlalchemy',
-        'sqlsoup',
-        'requests',
-        'argparse',
-        'sh',
-      ],
+      install_requires=requirements(),
       scripts=[
         'bin/hmda_create_schemas',
         'bin/hmda_load_code_sheet',
         'bin/hmda_load_cbsa',
         'bin/hmda_load_geo',
+        'bin/hmda_extract_geo_data'
       ],
       zip_safe=False)