Switch to uv (#62)

* updated to uv, removed poetry

* test actions

Author: TexasCoding

.github/workflows/test-package.yaml

@@ -18,47 +18,62 @@ jobs:
         matrix:
           python-version: ["3.12"]
           os: [ubuntu-latest, macOS-latest]
-      env:
-        POETRY_VIRTUALENVS_IN_PROJECT: true
-      steps:
-        - uses: actions/checkout@v3
-        - uses: actions/setup-python@v5
-          with:
-            python-version: ${{ matrix.python-version }}
+        steps:
+          - uses: actions/checkout@v4
+
+          - name: Install uv
+            uses: astral-sh/setup-uv@v2
+
+          - name: Set up Python
+            run: uv python install
+
+          - name: Install the project
+            run: uv sync --all-extras --dev
+
+          - name: Run tests
+            # For example, using `pytest`
+            run: uv run pytest tests
+      # env:
+      #   POETRY_VIRTUALENVS_IN_PROJECT: true
+      # steps:
+      #   - uses: actions/checkout@v3
+      #   - uses: actions/setup-python@v5
+      #     with:
+      #       python-version: ${{ matrix.python-version }}
 
-        # Cache the installation of Poetry itself, e.g. the next step. This prevents the workflow
-        # from installing Poetry every time, which can be slow. Note the use of the Poetry version
-        # number in the cache key, and the "-0" suffix: this allows you to invalidate the cache
-        # manually if/when you want to upgrade Poetry, or if something goes wrong.
-        - name: cache poetry install
-          uses: actions/cache@v4
-          with:
-            path: ~/.local
-            key: poetry-cache-${{ runner.os }}-${{ matrix.python-version }}-${{ env.POETRY_VERSION }}
+      #   # Cache the installation of Poetry itself, e.g. the next step. This prevents the workflow
+      #   # from installing Poetry every time, which can be slow. Note the use of the Poetry version
+      #   # number in the cache key, and the "-0" suffix: this allows you to invalidate the cache
+      #   # manually if/when you want to upgrade Poetry, or if something goes wrong.
+      #   - name: cache poetry install
+      #     uses: actions/cache@v4
+      #     with:
+      #       path: ~/.local
+      #       key: poetry-cache-${{ runner.os }}-${{ matrix.python-version }}-${{ env.POETRY_VERSION }}
 
-        # Install Poetry. You could do this manually, or there are several actions that do this.
-        # `snok/install-poetry` seems to be minimal yet complete, and really just calls out to
-        # Poetry's default install script, which feels correct. I pin the Poetry version here
-        # because Poetry does occasionally change APIs between versions and I don't want my
-        # actions to break if it does.
-        #
-        # The key configuration value here is `virtualenvs-in-project: true`: this creates the
-        # venv as a `.venv` in your testing directory, which allows the next step to easily
-        # cache it.
-        - uses: snok/install-poetry@v1
-          with:
-            version: 1.8.3
-            virtualenvs-create: true
-            virtualenvs-in-project: true
+      #   # Install Poetry. You could do this manually, or there are several actions that do this.
+      #   # `snok/install-poetry` seems to be minimal yet complete, and really just calls out to
+      #   # Poetry's default install script, which feels correct. I pin the Poetry version here
+      #   # because Poetry does occasionally change APIs between versions and I don't want my
+      #   # actions to break if it does.
+      #   #
+      #   # The key configuration value here is `virtualenvs-in-project: true`: this creates the
+      #   # venv as a `.venv` in your testing directory, which allows the next step to easily
+      #   # cache it.
+      #   - uses: snok/install-poetry@v1
+      #     with:
+      #       version: 1.8.3
+      #       virtualenvs-create: true
+      #       virtualenvs-in-project: true
 
-        #  Cache your dependencies (i.e. all the stuff in your `pyproject.toml`)
-        - name: cache venv
-          uses: actions/cache@v4
-          with:
-            path: .venv
-            key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
-        - run: poetry install --no-interaction --no-root
-          if: steps.cache-deps.outputs.cache-hit != 'true'
-        - run: poetry install --no-interaction
-        - run: poetry run ruff check --fix
-        - run: poetry run pytest
+      #   #  Cache your dependencies (i.e. all the stuff in your `pyproject.toml`)
+      #   - name: cache venv
+      #     uses: actions/cache@v4
+      #     with:
+      #       path: .venv
+      #       key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
+      #   - run: poetry install --no-interaction --no-root
+      #     if: steps.cache-deps.outputs.cache-hit != 'true'
+      #   - run: poetry install --no-interaction
+      #   - run: poetry run ruff check --fix
+      #   - run: poetry run pytest

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.4.8
+  rev: v0.6.8
   hooks:
     # Run the linter.
     - id: ruff

.python-version

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

docs/source/notebooks/usage.ipynb

@@ -34,8 +34,8 @@
     "from py_alpaca_api import PyAlpacaAPI\n",
     "\n",
     "# Load environment variables\n",
-    "api_key = os.environ.get('ALPACA_API_KEY')\n",
-    "api_secret = os.environ.get('ALPACA_SECRET_KEY')\n",
+    "api_key = os.environ.get(\"ALPACA_API_KEY\")\n",
+    "api_secret = os.environ.get(\"ALPACA_SECRET_KEY\")\n",
     "\n",
     "# Create an instance of PyAlpacaAPI\n",
     "api = PyAlpacaAPI(api_key=api_key, api_secret=api_secret, api_paper=True)"
@@ -90,7 +90,7 @@
     }
    ],
    "source": [
-    "asset = stock.assets.get('AAPL')\n",
+    "asset = stock.assets.get(\"AAPL\")\n",
     "pprint(asset)"
    ]
   },
@@ -127,7 +127,9 @@
     }
    ],
    "source": [
-    "asset_history = stock.history.get_stock_data(symbol=asset.symbol, start='2024-06-01', end='2024-06-07', timeframe='1d')\n",
+    "asset_history = stock.history.get_stock_data(\n",
+    "    symbol=asset.symbol, start=\"2024-06-01\", end=\"2024-06-07\", timeframe=\"1d\"\n",
+    ")\n",
     "pprint(asset_history)"
    ]
   },
@@ -241,8 +243,12 @@
     "# then uses Meta Prophet to predict future prices. Then it calculates the\n",
     "# percentage gain and returns a list of symbols that are predicted to gain.\n",
     "future_gainers = stock.predictor.get_losers_to_gainers(losers_to_scan=100)\n",
-    "print(\"This function uses Meta Prophet to predict future gainers. There is no guarantee that these stocks will gain.\")\n",
-    "print(f\"Out of 100 previous loser stocks, there are {len(future_gainers)} predicted to gain 10% in the next 14 days:\")\n",
+    "print(\n",
+    "    \"This function uses Meta Prophet to predict future gainers. There is no guarantee that these stocks will gain.\"\n",
+    ")\n",
+    "print(\n",
+    "    f\"Out of 100 previous loser stocks, there are {len(future_gainers)} predicted to gain 10% in the next 14 days:\"\n",
+    ")\n",
     "print(future_gainers)"
    ]
   }