MOD: Convert Python library to Poetry

Author: nmacholl

.github/workflows/release.yml

@@ -1,7 +1,5 @@
 name: release
 
-# Release Python client library on successful completion of the `test` workflow
-
 on:
   workflow_run:
     workflows:
@@ -20,29 +18,22 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-        with:
-          fetch-depth: 2
 
-      # Python setup
       - name: Set up Python environment
         uses: actions/setup-python@v4
         with:
           python-version: "3.10"
 
-      # Install dependencies
-      - name: Install dependencies
+      - name: Install poetry
         run: |
-          python -m pip install --upgrade pip setuptools wheel
-          scripts/build.sh
+          python -m pip install --upgrade pip poetry==1.3.2
 
-      # Set release output variables
-      - name: Set output
+      - name: Prepare release
         id: vars
         run: |
-          echo "::set-output name=tag_name::v$(python setup.py --version)"
-          echo "::set-output name=release_name::$(python setup.py --version)"
+          echo "tag_name=v$(poetry version -s)" >> $GITHUB_ENV
+          echo "release_name=$(poetry version)" >> $GITHUB_ENV
 
-      # Create GitHub release
       - name: Create release
         id: create-release
         uses: actions/create-release@v1
@@ -58,110 +49,44 @@ jobs:
 
   publish-sdist:
     needs: [tag-release]
-    name: publish-sdist - Python 3.10 (ubuntu-latest)
+    name: publish - Python 3.10 (ubuntu-latest)
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v3
 
-      # Python setup
       - name: Set up Python environment
         uses: actions/setup-python@v4
         with:
           python-version: "3.10"
 
-      # Install release dependencies
-      - name: Install release dependencies
+      - name: Install poetry
         run: |
-          python -m pip install --upgrade pip setuptools wheel twine
-          pip install -r requirements.txt
-          pip install -r requirements_dev.txt
-
-      # Create distribution
-      - name: Package for release
-        run: python setup.py sdist
+          python -m pip install --upgrade pip poetry==1.3.2
 
-      # Set release output variables
-      - name: Set output
-        id: vars
+      - name: Build
         run: |
-          echo "::set-output name=asset_path::$(find ./dist -mindepth 1 -print -quit)"
-          cd dist
-          echo "::set-output name=asset_name::$(printf '%s\0' * | awk 'BEGIN{RS="\0"} {print;  exit}')"
-
-      # Upload release asset
-      - name: Upload release asset
-        id: upload-release-asset
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          ASSET_PATH: ${{ steps.vars.outputs.asset_path }}
-          ASSET_NAME: ${{ steps.vars.outputs.asset_name }}
-        with:
-          upload_url: ${{ needs.tag-release.outputs.upload_url }}
-          asset_path: ${{ env.ASSET_PATH }}
-          asset_name: ${{ env.ASSET_NAME }}
-          asset_content_type: application/zip
-
-      # Publish to PyPI
-      - name: Publish to PyPI
-        id: publish-to-pypi
-        env:
-          TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
-          TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
-        run: twine upload dist/*
-
-  publish-wheel:
-    needs: [tag-release]
-    name: publish-wheel - Python 3.10 (ubuntu-latest)
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-
-      # Python setup
-      - name: Set up Python environment
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.10"
-
-      # Install release dependencies
-      - name: Install release dependencies
-        run: |
-          python -m pip install --upgrade pip setuptools wheel twine
-          pip install -r requirements.txt
-          pip install -r requirements_dev.txt
-
-      # Create distribution
-      - name: Package for release
-        run: python setup.py bdist_wheel
+          poetry build
 
-      # Set release output variables
-      - name: Set output
+      - name: Prepare artifacts
         id: vars
         run: |
-          echo "::set-output name=asset_path::$(find ./dist -mindepth 1 -print -quit)"
-          cd dist
-          echo "::set-output name=asset_name::$(printf '%s\0' * | awk 'BEGIN{RS="\0"} {print;  exit}')"
+          echo "asset_path=$(find ./dist -mindepth 1 -print -quit)" >> $GITHUB_ENV
+          echo "asset_name=databento-*.tar.gz,databento-*.whl" >> $GITHUB_ENV
 
-      # Upload release asset
       - name: Upload release asset
         id: upload-release-asset
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          ASSET_PATH: ${{ steps.vars.outputs.asset_path }}
-          ASSET_NAME: ${{ steps.vars.outputs.asset_name }}
         with:
           upload_url: ${{ needs.tag-release.outputs.upload_url }}
           asset_path: ${{ env.ASSET_PATH }}
           asset_name: ${{ env.ASSET_NAME }}
           asset_content_type: application/zip
 
-      # Publish to PyPI
       - name: Publish to PyPI
         id: publish-to-pypi
         env:
-          TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
-          TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
-        run: twine upload dist/*
+          POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}
+        run: poetry publish

.github/workflows/test.yml

@@ -1,7 +1,5 @@
 name: test
 
-# Test the Python client library
-
 on:
   push:
     branches: [main, dev]
@@ -19,18 +17,25 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      # Python setup
       - name: Set up Python environment
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Install
-        run: |
-          python -m pip install --upgrade pip setuptools wheel
-          scripts/build.sh
+      - name: Install poetry
+        run: python -m pip install --upgrade pip poetry==1.3.2
+
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v3
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: scripts/build.sh
 
-      # Run tests
       - name: Run tests in release mode
         if: ${{ github.ref == 'refs/heads/main' }}
         run: scripts/test.sh --release

MANIFEST.in

@@ -28,14 +28,14 @@ You can find our full client API reference on the [Historical Reference](https:/
 
 ## Requirements
 The library is fully compatible with the latest distribution of Anaconda 3.7 and above.
-The minimum dependencies as found in the `requirements.txt` are also listed below:
-- Python (>=3.7)
-- aiohttp (>=3.7.2,<4.0.0)
-- databento-dbn (==0.6.1)
-- numpy (>=1.17.0)
-- pandas (>=1.1.3)
-- requests (>=2.24.0)
-- zstandard (>=0.21.0)
+The minimum dependencies as found in the `pyproject.toml` are also listed below:
+- python = "^3.7"
+- aiohttp = "^3.7.2"
+- databento-dbn = "0.6.1"
+- numpy= ">=1.17.0"
+- pandas = ">=1.1.3"
+- requests = ">=2.24.0"
+- zstandard = ">=0.20.0"
 
 ## Installation
 To install the latest stable version of the package from PyPI:

README.md

@@ -0,0 +1,60 @@
+[tool.poetry]
+name = "databento"
+version = "0.13.0"
+description = "Official Python client library for Databento"
+authors = [
+    "Databento <[email protected]>",
+]
+license = "Apache License 2.0"
+packages = [{include = "databento"}]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Office/Business :: Financial",
+    "Topic :: Office/Business :: Financial :: Investment",
+]
+readme = "README.md"
+documentation = "https://docs.databento.com"
+homepage = "https://databento.com"
+repository = "https://github.com/databento/databento-python"
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/databento/databento-python/issues"
+
+[tool.poetry.dependencies]
+python = "^3.7"
+aiohttp = "^3.7.2"
+databento-dbn = "0.6.1"
+numpy= ">=1.17.0"
+pandas = ">=1.1.3"
+requests = ">=2.24.0"
+zstandard = ">=0.20.0"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "1.2.0"
+pytest = ">=7.3.1"
+pytest-asyncio = ">=0.21.0"
+pytest-mock = ">=3.10.0"
+types-requests = "^2.30.0.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.mypy]
+python_version = 3.7
+disallow_untyped_defs = true
+disallow_any_generics = true
+disallow_subclassing_any = true
+ignore_missing_imports = true
+namespace_packages = true
+no_strict_optional = true
+warn_no_return = true
+warn_unused_configs = true
+warn_unused_ignores = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "--asyncio-mode auto"

mypy.ini

@@ -1,5 +1,2 @@
 #! /usr/bin/env bash
-set -e
-pip3 install -r requirements.txt
-pip3 install -r requirements_dev.txt
-pip3 install .
+poetry install --with=dev --no-interaction --no-root

pyproject.toml

@@ -1,4 +1,4 @@
 #! /usr/bin/env bash
 echo $(mypy --version)
 echo Running mypy...
-mypy databento examples tests --config-file mypy.ini
+poetry run mypy databento examples tests

requirements_dev.txt

@@ -1,2 +1,2 @@
 #! /usr/bin/env bash
-pytest tests . $@
+poetry run pytest tests . $@