Switch from Poetry to uv

Author: rlan

.github/workflows/python-app.yml

@@ -1,5 +1,6 @@
 # This workflow will install Python dependencies, run tests and lint with a single version of Python
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+# GitHub docs: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+# uv docs: https://docs.astral.sh/uv/guides/integration/github/
 
 name: Testing
 
@@ -14,31 +15,36 @@ permissions:
 
 jobs:
   build:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+        # uv supports python 3.8 and higher
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
     - uses: actions/checkout@v4
-    - name: Install Poetry
-      run: |
-        pipx install poetry
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
       with:
+        # Install a specific version of uv.
+        version: "0.7.3"
         python-version: ${{ matrix.python-version }}
-    - name: Install the code linting and formatting tool Ruff
-      run: |
-        pipx install ruff
+
     - name: Lint with Ruff
       run: |
-        ruff check --output-format=github .
-    - name: Installation
+        uvx ruff check --output-format=github .
+
+    - name: Set up Python ${{ matrix.python-version }}
       run: |
-        poetry install
+        uv python install
+
+    - name: Install the project
+      run: |
+        uv sync --all-extras
+
     - name: Test with example.csv
       run: |
-        poetry run schwab2pp example.csv -p test.csv
+        uv run schwab2pp example.csv -p test.csv
         diff example_out.csv test.csv

.python-version

@@ -0,0 +1 @@
+3.12

README.md

@@ -1,7 +1,8 @@
 # A Charles Schwab CSV Converter for Portfolio Performance
 
 [![Testing badge](https://github.com/rlan/convert-csv-schwab2pp/actions/workflows/python-app.yml/badge.svg)](https://github.com/rlan/convert-csv-schwab2pp/actions)
-![Python versions](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)
+![Python versions](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 ![MIT license](https://img.shields.io/github/license/rlan/convert-csv-schwab2pp)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15024607.svg)](https://doi.org/10.5281/zenodo.15024607)
@@ -20,18 +21,26 @@ After conversion, this [step-by-step guide](./guide/README.md) creates a new por
 
 ## Installation
 
-First, install [pipx](https://github.com/pypa/pipx) (not pip).
+First, install [uv](https://github.com/astral-sh/uv).
 
 Then:
 
 ```sh
-pipx install git+https://github.com/rlan/convert-csv-schwab2pp
+uv tool install git+https://github.com/rlan/convert-csv-schwab2pp
 ```
 
+Verify installation:
 
-### Try it out!
+```sh
+uv tool list
+```
 
-Let's see if installation was successful:
+```txt
+schwab2pp v1.0.0
+- schwab2pp
+```
+
+### Try it out!
 
 ```sh
 schwab2pp --help
@@ -54,8 +63,8 @@ optional arguments:
 
 Example:
 
-An example Schwab CSV: [example.csv](example.csv).
-The converted ready-to-import CSV file: [example_out.csv](example_out.csv).
+- An example Schwab CSV: [example.csv](example.csv).
+- The converted ready-to-import CSV file: [example_out.csv](example_out.csv).
 
 To replicate this conversion:
 
@@ -67,35 +76,35 @@ schwab2pp example.csv -p example_out.csv
 ### Update to a new version
 
 ```sh
-pipx upgrade schwab2pp
+uv tool upgrade schwab2pp
 ```
 
 
 ### Uninstallation
 
 ```sh
-pipx uninstall schwab2pp
+uv tool uninstall schwab2pp
 ```
 
 
 ## Details
 
 Supported transactions:
 
-* "NRA Tax Adj"
-* "Credit Interest"
-* "NRA Withholding"
-* "Short Term Cap Gain"
-* "Long Term Cap Gain"
-* "Cash Dividend"
-* "Buy"
-* "Wire Received"
-* "Wire Sent"[^1] (Thank you, [@ipaulo](https://github.com/ipaulo))
-* "Sell" (Not verified)
+- "NRA Tax Adj"
+- "Credit Interest"
+- "NRA Withholding"
+- "Short Term Cap Gain"
+- "Long Term Cap Gain"
+- "Cash Dividend"
+- "Buy"
+- "Wire Received"
+- "Wire Sent"[^1] (Thank you, [@ipaulo](https://github.com/ipaulo))
+- "Sell" (Not verified)
 
 Not-yet-supported transactions:
 
-* ACH deposit and withdrawal
+- ACH deposit and withdrawal
 
 I have actual transactions for the supported transactions. "Sell" is an educated guess; I don't have an actual sale. If you could share actual transactions for not-yet-supported ones, please let me know. Thank you.
 
@@ -108,6 +117,44 @@ Dates:
 If date is in "date1 as of date2" format, "date1" will be used and "as of date2" will be appended to the resulting "Note" column.
 
 
+## Development
+
+Development is on the `develop` branch. Please send PR there.
+
+How to set up the development environment:
+
+- Install [uv](https://github.com/astral-sh/uv).
+- Clone this repo.
+- Install project:
+
+```sh
+cd convert-csv-schwab2pp
+git checkout develop
+uv sync --locked --all-extras
+```
+
+- Edit code.
+
+- Update install:
+
+```sh
+uv sync
+```
+
+- Run test:
+
+```sh
+uv run schwab2pp example.csv -p test.csv
+diff example_out.csv test.csv
+```
+
+- Run ruff:
+
+```sh
+uvx ruff check
+uvx ruff format
+```
+
 ## Citation
 
 If this project helps your research, don't hesitate to spread the word! Click on the badge below and find citation formats (e.g., BibTeX and etc) at the bottom of that page.