Merge pull request #9 from u2berggeist/versioning_v0.2.4

Versioning v0.2.4

Author: jrwrigh

CHANGELOG.md

@@ -2,9 +2,12 @@
 
 ## Unreleased
 
+## 0.2.4 - 2018-07-02
+
 ### Added 
 - translations.json now has a "IGNORE" category options
 - README has better documentation on using translations.json
+- Compiled Examples files into example folder
 
 ## 0.2.3 - 2018-07-01
 
@@ -37,4 +40,4 @@
 ### Added
 - Current will take CSV from Mint, pre-process the data, then add it to the GNUCash book
 - All inputs are given in the single script itself
-- Translations for the preprocessing are in `translations.json`
+- Translations for the preprocessing are in `translations.json`

README.md

@@ -1,11 +1,11 @@
 # csv2cash
-Repo for importing CSV files to GNUCash with some preprocessing built in.
+Python package for importing CSV files to GNUCash with some preprocessing built in.
 
 ## What does it do?
 ### It takes your raw transfer data and compiles it into transactions
-A transfer is simply half of a transaction in double-entry bookkeeping (which GNUCash uses). So if you move money from Bank Account A to Bank Account B, then you have two transfer records; one from Bank Account A saying XXX money was withdrawn and one from Bank Account B saying XXX money was deposited. 
+A transfer is simply half of a transaction in [double-entry bookkeeping](https://en.wikipedia.org/wiki/Double-entry_bookkeeping_system) ([which GNUCash uses](https://www.gnucash.org/features.phtml#main-feat)). So if you move money from Bank Account A to Bank Account B, then you have two transfer records, one for each Account. One from Bank Account A saying $XXX money was withdrawn and one from Bank Account B saying $XXX money was deposited. In GNUCash, though, these two transfers are viewed as a single transaction: $XXX was moved from Bank Account A --> Bank Account B.
 
-In Mint for example, if you export a CSV of all your transfer data, it will keep each transfer separate from the other, even though they are directly related and should be viewed as a single transaction. This script finds the separate transfers, figures out which ones correspond to each other, and puts their data together
+In Mint for example, if you export a CSV of all your transfer data, it will keep each transfer separate from the other, even though they are directly related and should be viewed as a single transaction. This package finds the separate transfers, figures out which ones correspond to each other, and puts their data together
 
 ### Translates your CSV categories into a GNUCash account
 Say your CSV has a category system attached to each transfer and you want that organization to be transferred into Mint without having to go one-by-one through every transfer and label them. This will do that by setting up the `translation.json` dictionary, which will take a transfer that is under a given category, and place it in the corresponding GNUCash account.
@@ -14,12 +14,12 @@ Use the `get_uncat_transfers` function to view any transactions that haven't bee
 
 ## Requirements
 - pandas
-- piecash (see note below about versioning)
+- piecash (see [note](#note) below about versioning)
 - Verified for Python 3.6, though should work for other versions
 
 # Instructions:
 
-See examples in `./example` (to be done soon) for how to use the module effectively. 
+See examples in `./example` for how to use the module effectively. 
 
 ## Structure:
 The module takes data from a .csv file, translates information (such as category and account names) by referencing the `translations.json` dictionary, combines internal transfers (ie. moving money from savings account to checking account), and puts the translated data into the GNUCash Book of your choosing.

setup.py

@@ -5,11 +5,11 @@
 
 setuptools.setup(
     name="csv2cash",
-    version="0.1.0",
+    version="0.2.4",
     author="u2berggeist",
     description="Module to process CSV and import into GNUCash",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/u2berggeist/csv2cash",
     packages=setuptools.find_packages()
-)
+)