Update testing GH Action. Add Ruff. Add Python 3.11 and 3.12.

Author: rlan

.github/workflows/python-app.yml

@@ -21,25 +21,22 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    - name: Lint with flake8
+    - name: Lint with Ruff
       run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+        pip install ruff
+        ruff --output-format=github .
     - name: Test with example.csv
       run: |
         python convert.py example.csv -p test.csv

README.md

@@ -1,8 +1,7 @@
 # A Charles Schwab CSV Converter for Portfolio Performance
 
-[![Python CI](https://github.com/rlan/convert-csv-schwab2pp/actions/workflows/python-app.yml/badge.svg)](https://github.com/rlan/convert-csv-schwab2pp/actions)
-![Last commit date](https://img.shields.io/github/last-commit/rlan/convert-csv-schwab2pp)
-![Eclipse Public License - v 2.0](https://img.shields.io/github/license/rlan/convert-csv-schwab2pp)
+[![Testing badge](https://github.com/rlan/convert-csv-schwab2pp/actions/workflows/python-app.yml/badge.svg)](https://github.com/rlan/convert-csv-schwab2pp/actions)
+![MIT license](https://img.shields.io/github/license/rlan/convert-csv-schwab2pp)
 
 Converts a [Charles Schwab](https://www.schwab.com/) transaction CSV file to a ready-to-import CSV file for [Portfolio Performance](https://www.portfolio-performance.info/en/) (PP).
 
@@ -22,7 +21,7 @@ Although Google Colab is free, one will need a [Google account](https://www.goog
 
 Runtime Requirements:
 
-* Python 3.7, 3.8, 3.9 or 3.10[^1]
+* Python 3.7, 3.8, 3.9, 3.10, 3.11, 3.12.
 * Pandas
 
 Install this tool in a Python virtual environment:
@@ -42,7 +41,7 @@ Command-line options:
 python convert.py --help
 ```
 
-```
+```txt
 usage: convert.py [-h] [-p PP_CSV] schwab_csv
 
 Converts a Charles Schwab transaction CSV file to a ready-to-import CSV file for Portfolio
@@ -96,5 +95,3 @@ As far as I can test, PP will detect and skip duplicate transactions. So it is s
 ## License
 
 MIT
-
-[^1]: Python 3.11 not yet officially supported by Pandas, as of 2022-11-15.

convert.py

@@ -6,47 +6,48 @@
 
 try:
     import pandas as pd
-except ImportError:
-    raise ImportError('Is Pandas installed?')
+except ImportError as exc:
+    raise ImportError("Is Pandas installed?") from exc
 
 
 parser = argparse.ArgumentParser(
-    description=('Converts a Charles Schwab transaction CSV file to a'
-                 ' ready-to-import CSV file for Portfolio Performance.'))
+    description=(
+        "Converts a Charles Schwab transaction CSV file to a"
+        " ready-to-import CSV file for Portfolio Performance."
+    )
+)
+parser.add_argument("schwab_csv", type=str, help="Input Charles Schwab CSV file")
 parser.add_argument(
-    'schwab_csv', type=str,
-    help='Input Charles Schwab CSV file')
-parser.add_argument(
-    '-p', '--pp_csv', type=str,
-    default='pp.csv',
-    help='Resulting CSV file for Portfolio Performance (default: pp.csv)')
+    "-p",
+    "--pp_csv",
+    type=str,
+    default="pp.csv",
+    help="Resulting CSV file for Portfolio Performance (default: pp.csv)",
+)
 args = parser.parse_args()
 
 
 if not os.path.isfile(args.schwab_csv):
-    print(f'{args.schwab_csv} not found')
+    print(f"{args.schwab_csv} not found")
     sys.exit(1)
 
 
 # A Charles Scwab CSV starts with a prefix and a suffix row
 # Prefix: "Transactions  for account...
 # Suffix: "Transactions Total"
-df = pd.read_csv(args.schwab_csv,
-                 skiprows=1,
-                 skipfooter=1,
-                 engine='python')
+df = pd.read_csv(args.schwab_csv, skiprows=1, skipfooter=1, engine="python")
 
 # Convert dates to datetime objects
-df['Date'] = pd.to_datetime(df['Date'], format='%m/%d/%Y')
+df["Date"] = pd.to_datetime(df["Date"], format="%m/%d/%Y")
 
 # Rename column names
 column_new_names = {
-    'Action': 'Note',
-    'Symbol': 'Ticker Symbol',
-    'Description': 'Security Name',
-    'Quantity': 'Shares',
-    'Fees & Comm': 'Fees',
-    'Amount': 'Value',
+    "Action": "Note",
+    "Symbol": "Ticker Symbol",
+    "Description": "Security Name",
+    "Quantity": "Shares",
+    "Fees & Comm": "Fees",
+    "Amount": "Value",
 }
 df.rename(columns=column_new_names, inplace=True)
 
@@ -55,61 +56,62 @@
 def remove_currency(text: str):
     import re
     import locale
-    decimal_point_char = locale.localeconv()['decimal_point']
-    clean = re.sub(r'[^0-9'+decimal_point_char+'-'+r']+', '', text)
+
+    decimal_point_char = locale.localeconv()["decimal_point"]
+    clean = re.sub(r"[^0-9" + decimal_point_char + "-" + r"]+", "", text)
     return clean
 
 
-new_value = df['Value'].apply(remove_currency)
-df['Value'] = new_value
+new_value = df["Value"].apply(remove_currency)
+df["Value"] = new_value
 
 # Add a new column with all USD: Transaction Currency
-transaction_currency = ["USD" for x in df['Value']]
-df['Transaction Currency'] = transaction_currency
+transaction_currency = ["USD" for x in df["Value"]]
+df["Transaction Currency"] = transaction_currency
 
 # Convert Action to Type
 action_to_type = {
-    'NRA Tax Adj': 'Taxes',
-    'Credit Interest': 'Interest',
-    'NRA Withholding': 'Taxes',
-    'Short Term Cap Gain': 'Dividend',
-    'Long Term Cap Gain': 'Dividend',
-    'Cash Dividend': 'Dividend',
-    'Buy': 'Buy',
-    'Sell': 'Sell',
-    'Wire Received': 'Deposit',
-    'Advisor Fee': 'Fees',
-    'Reinvest Dividend': 'Dividend',
-    'Reinvest Shares': 'Buy',
-    'Bank Interest': 'Dividend',
-    'Funds Received': 'Deposit',
-    'MoneyLink Transfer': 'Deposit',
+    "NRA Tax Adj": "Taxes",
+    "Credit Interest": "Interest",
+    "NRA Withholding": "Taxes",
+    "Short Term Cap Gain": "Dividend",
+    "Long Term Cap Gain": "Dividend",
+    "Cash Dividend": "Dividend",
+    "Buy": "Buy",
+    "Sell": "Sell",
+    "Wire Received": "Deposit",
+    "Advisor Fee": "Fees",
+    "Reinvest Dividend": "Dividend",
+    "Reinvest Shares": "Buy",
+    "Bank Interest": "Dividend",
+    "Funds Received": "Deposit",
+    "MoneyLink Transfer": "Deposit",
 }
-new_type = [action_to_type[x] for x in df['Note']]
-df['Type'] = new_type
+new_type = [action_to_type[x] for x in df["Note"]]
+df["Type"] = new_type
 
 # Delete Price column
-df.drop(columns=['Price'], inplace=True)
+df.drop(columns=["Price"], inplace=True)
 
 # Add SCHWAB1 INT to Notes
-for k, v in df['Security Name'].items():
-    if v.startswith('SCHWAB1 INT'):
-        df.at[k, 'Note'] = df.at[k, 'Note'] + ' ' + v
+for k, v in df["Security Name"].items():
+    if v.startswith("SCHWAB1 INT"):
+        df.at[k, "Note"] = df.at[k, "Note"] + " " + v
 
 
 # Remove non-security names
 def convert_security_name(data: str):
-    if data.startswith('SCHWAB1 INT'):
-        return ''
-    elif data.startswith('WIRED FUNDS RECEIVED'):
-        return ''
+    if data.startswith("SCHWAB1 INT"):
+        return ""
+    elif data.startswith("WIRED FUNDS RECEIVED"):
+        return ""
     else:
         return data
 
 
-new_security_name = [convert_security_name(v) for v in df['Security Name']]
-df['Security Name'] = new_security_name
+new_security_name = [convert_security_name(v) for v in df["Security Name"]]
+df["Security Name"] = new_security_name
 
 # Write to CSV file
-df.to_csv(args.pp_csv, index=False, date_format='%Y-%m-%d')
+df.to_csv(args.pp_csv, index=False, date_format="%Y-%m-%d")
 print(args.pp_csv)

ruff.toml

@@ -0,0 +1,17 @@
+[lint]
+# 1. Enable flake8-bugbear (`B`) rules, in addition to the defaults.
+select = ["E4", "E7", "E9", "F", "B"]
+
+# 2. Avoid enforcing line-length violations (`E501`)
+ignore = ["E501"]
+
+# 3. Avoid trying to fix flake8-bugbear (`B`) violations.
+unfixable = ["B"]
+
+# 4. Ignore `E402` (import violations) in all `__init__.py` files, and in select subdirectories.
+[lint.per-file-ignores]
+"__init__.py" = ["E402"]
+"**/{tests,docs,tools}/*" = ["E402"]
+
+[format]
+docstring-code-format = true