wip: Interim changes to transfer computers

Author: tim-rohrer

README.md

@@ -13,6 +13,14 @@ One area _Move2GnuCash_ will attempt to diverge from `csv2cash` is that the exis
 -   PieCash
 -   Pandas
 
+## Limitations
+
+Due to Quicken's manner of exporting data, account balances and categories need to be in place in the GnuCash book prior to the import of transactions. While this can be done manually (you still need to make them match what is coming out of Quicken!), _Move2GnuCash_ has options for importing these through two processes described below.
+
+The challenges are exacerbated by limitations with Quicken's export of _All Transactions_ because we cannot group all non-investment accounts together into one export file. It becomes easier to export all transactions as one file and then let _Move2GnuCash_ divide the data into investment and non-investment transactions for processing.
+
+_Move2GnuCash_ assumes all investment transaction history (in support of cost basis tracking) is present in the file even if non-investment transactions are limited to recent history (i.e., the chosen date for account balances described below). The implication is that non-investment transactions prior to th opening balances date will be filtered out while investment transactions will be retained.
+
 ## Exports from Quicken
 
 _Move2GnuCash_ requires a minimum of two files from Quicken for each import process. Because exported CSV files from Quicken contain a varying number of extraneous lines and comments, these will have to be edited to get to final form.
@@ -27,32 +35,34 @@ With non-investment accounts, I chose 1 January 2017 as the start date, and so I
 
 ~~I then removed the top header lines (except the date), moved the labels from the first column to the second column, and removed the the other unnecessary formatting lines. In the end, the format of your file should look like this sample:~~
 
-| ~~                  | Accounts | 12/31/2016 |
+~~
+| | Accounts | 12/31/2016 |
 | ------------------- | -------- | ---------- |
-| Assets              |          |
-| Cash                |          |
-| - Cash              | 77.12    |
-| - Checking One      | 440.84   |
-| - Checking Two      | 235.38   |
-| - Total Cash        | 753.34   |
-| Savings             |          |
-| - Spouse Savings    | 987.12   |
-| - Family Savings    | 3250     |
-| - Total Savings     | 4237.12  |
-| Property            |          |
-| - 2012 Silverado    | 30975    |
-| - 2012 Camper       | 0        |
-| - Total Property    | 39975    |
-| Total Assets        | 44965.46 |
-| Liabilities         |          |
-| Credit Card         |          |
-| - Apple Card        | 0        |
-| - Credit Card       | -973.4   |
-| - Total Credit Card | -973.4   |
-| Loan                |          |
-| - Student Loan      | -10500   |
-| - Total Loan        | -10650   |
-| Total Liabilities   | -11623   | ~~         |
+| Assets | |
+| Cash | |
+| - Cash | 77.12 |
+| - Checking One | 440.84 |
+| - Checking Two | 235.38 |
+| - Total Cash | 753.34 |
+| Savings | |
+| - Spouse Savings | 987.12 |
+| - Family Savings | 3250 |
+| - Total Savings | 4237.12 |
+| Property | |
+| - 2012 Silverado | 30975 |
+| - 2012 Camper | 0 |
+| - Total Property | 39975 |
+| Total Assets | 44965.46 |
+| Liabilities | |
+| Credit Card | |
+| - Apple Card | 0 |
+| - Credit Card | -973.4 |
+| - Total Credit Card | -973.4 |
+| Loan | |
+| - Student Loan | -10500 |
+| - Total Loan | -10650 |
+| Total Liabilities | -11623 | |
+~~
 
 _Move2GnuCash_ function `opening_book` retrieves the date (balances as of close of business) from the first line. The second line, because it has no associated figure in the second column, will be created as a [placeholder account](https://www.gnucash.org/docs/v4/C/gnucash-help/acct-create.html#accts-placeholder) and will be the parent of the next account created, and so on, until the accounts containing transactions are created (the hyphens will be removed).
 
@@ -97,7 +107,7 @@ TODO: Finish this documenting.
 
 GnuCash uses [double entry accounting](https://www.investopedia.com/terms/d/double-entry.asp). PieCash uses the term splits to refer to these particulars in a [transaction](https://piecash.readthedocs.io/en/master/tutorial/index_new.html#creating-a-new-transaction), which can be confusing for those used to Quicken, and perhaps Mint.
 
-Move-to-GnuCash will map CSV entries and account for splits by creating multi-split transactions for GnuCash.
+_Move2GnuCash_ will map CSV entries to account for splits by creating multi-split transactions for GnuCash.
 
 For example, consider this csv file which would reflect an expense in Quicken where \$11.50 is charged to the Dining category and \$0.95 reflects the sales tax charged by the state:
 
@@ -106,7 +116,7 @@ For example, consider this csv file which would reflect an expense in Quicken wh
 | S     | 01/22/2023 | Payment/Deposit | Breakfast Place | Dining    | -10.55 | My Credit Card |
 | S     | 01/22/2023 | Payment/Deposit | Breakfast Place | Sales Tax | -0.95  | My Credit Card |
 
-GnuCash treats categories as just another account. When the transaction is created by PieCash, it will include three splits in order to capture the changes to all three accounts. Extending the idea presented in the PieCash tutorial examples, it might look like this:
+GnuCash treats categories as just another account. When the transaction is created by _Move2GnuCash_/PieCash, it will include three splits in order to capture the changes to all three accounts. Extending the idea presented in the PieCash tutorial examples, it might look like this:
 
 ```python
 trans1 = Transaction(

src/move2gnucash/__main__.py

@@ -0,0 +1,96 @@
+"""Move2GnuCash"""
+import argparse
+from unicodedata import category
+
+from piecash import Book, create_book, GnucashException, open_book
+
+from move2gnucash.migrations import *
+
+
+class CapitalizedHelpFormatter(argparse.HelpFormatter):
+    """Class needed to write command line help using proper English."""
+
+    def add_usage(self, usage, actions, groups, prefix=None):
+        if prefix is None:
+            prefix = "Usage: "
+        return super(CapitalizedHelpFormatter, self).add_usage(usage, actions, groups, prefix)
+
+
+parser = argparse.ArgumentParser(add_help=False, formatter_class=CapitalizedHelpFormatter)
+parser._positionals.title = "Positional arguments"
+parser._optionals.title = "Optional arguments"
+
+parser.add_argument(
+    "-v",
+    "--version",
+    action="version",
+    version="%(prog)s 1.0",
+    help="Show program's version number and exit.",
+)
+
+parser.add_argument(
+    "input_file", help="The csv file containing the input data. Typical extension: '.csv'."
+)
+parser.add_argument(
+    "output_file",
+    help="The name of the GnuCash file to create/write. Typical extension: '.gnucash'.",
+)
+parser.add_argument(
+    "action",
+    choices=["ACCTS", "CATS", "IE"],
+    help="Specify migration action. ACCTS for accounts/balances; CATS for categories; IE for income and expense transactions.",
+)
+parser.add_argument(
+    "-d", "--dry-run", help="Executes without writing a GnuCash file.", action="store_true"
+)
+parser.add_argument(
+    "-h",
+    "--help",
+    action="help",
+    default=argparse.SUPPRESS,
+    help="Show this help message and exit.",
+)
+
+args = parser.parse_args()
+
+
+def create_memory_book() -> Book:
+    return create_book(currency="USD")
+
+
+def get_book(book_name: str, dry_run: bool) -> Book:
+    try:
+        book_instance = open_book(book_name, readonly=False)
+        print(
+            "Existing book opened, and data will be added to it (unless dry-run is True). If you meant to create a new book, re-run using a different book name."
+        )
+        if dry_run:
+            book_instance = create_memory_book()
+            print("Since dry-run is True, an empty in-memory book was created.")
+
+    except GnucashException:
+        print(
+            "Book doesn't exists...creating. If dry-run is True, the returned book instance will be in-memory vice a file."
+        )
+        if dry_run:
+            book_instance = create_memory_book()
+        else:
+            book_instance: Book = create_book(args.output_file, currency="USD")
+    return book_instance
+
+
+book = get_book(args.output_file, args.dry_run)
+
+match args.action:
+    case "ACCTS":
+        opening_balances(args.input_file, book)
+        print("Accounts and opening balances imported.")
+    case "CATS":
+        category_accounts(args.input_file, book)
+        print("Categories imported as accounts.")
+    case "IE":
+        transactions(args.input_file, book)
+    case _:
+        print("Something weird occurred.")
+
+book.close()

src/move2gnucash/data_maps.py

@@ -50,13 +50,13 @@ class Transaction2Move:
 def _split2move_list(split):
     return [
         Split2Move(
-            split["tran_acct_from"],  # Set to path_and_name for look up
-            decimal_to(-split["tran_amount"]),
+            split["tran_acct_from"],
+            decimal_to(split["tran_amount"]) * -1,
             split.tran_memo,
         ),
         Split2Move(
             split["tran_acct_to"],
-            decimal_to(split["tran_amount"]),
+            decimal_to(split["tran_amount"]) * 1,
             split.tran_memo,
         ),
     ]
@@ -76,11 +76,12 @@ def _transaction2move(
     )
 
 
-def _build_multi_splits_tran(split_group):
+def _build_multi_splits_tran(split_group: pd.DataFrame):
     splits = split_group.apply(_split2move_list, axis=1)
     splits_list = [elem for item in splits for elem in item]
+
     return _transaction2move(
-        posted=datetime.strptime(split_group["tran_date"].iat[0], "%m/%d/%Y").date(),
+        posted=split_group["tran_date"].iat[0],
         description=split_group.tran_description.iat[0],
         notes=split_group.tran_memo.iat[0],
         num=split_group.tran_num.iat[0],
@@ -91,7 +92,7 @@ def _build_multi_splits_tran(split_group):
 def _build_single_splits_tran(split_data: pd.Series) -> Transaction2Move:
     splits_list = _split2move_list(split_data)
     return _transaction2move(
-        posted=datetime.strptime(split_data["tran_date"], "%m/%d/%Y").date(),
+        posted=split_data.tran_date,
         description=split_data["tran_description"],
         notes=split_data["tran_memo"],
         num=split_data["tran_num"],
@@ -123,6 +124,7 @@ def _processed_transactions(transactions: pd.DataFrame):
         if len(single_splits_data) > 0
         else []
     )
+
     return multi_split_transactions + single_split_transactions