CI + linting + fixes #1

fixes + CI improvements + linting #patch

Author: nmichlo

.github/workflows/lint.yml

@@ -0,0 +1,8 @@
+name: lint
+on: [ pull_request ]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3

.github/workflows/python-publish.yml

@@ -1,34 +1,21 @@
 # This workflow will upload a Python Package
-# using Twine when a release is created
-
 name: publish
-
 on:
+  push:
+    tags: ['v*.*.*']
   release:
     types: [created]
-
 jobs:
   deploy:
-
     runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v2
-
-    - name: Set up Python
-      uses: actions/setup-python@v2
+    - uses: actions/checkout@v4
+    - uses: astral-sh/setup-uv@v5
       with:
-        python-version: '3.x'
-
-    - name: Install dependencies
-      run: |
-        python3 -m pip install --upgrade pip
-        python3 -m pip install setuptools wheel twine
+        version: "latest"
+        python-version: '3.9'
 
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+    - name: Build and Publish
       run: |
-        python3 setup.py sdist bdist_wheel
-        python3 -m twine upload dist/*
+        uv build
+        uv publish --username="__token__" --password="${{ secrets.PYPI_TOKEN }}"

.github/workflows/python-test.yml

@@ -0,0 +1,47 @@
+# This workflow will install Python dependencies,
+# then run tests over a variety of Python versions.
+
+# name: test
+#
+# on:
+#   push:
+#     tags: [ '*' ]
+#   pull_request:
+#     branches: [ "main", "dev*", "feature*", "fix*"]
+#
+# jobs:
+#   build:
+#     runs-on: ${{ matrix.os }}
+#     strategy:
+#       matrix:
+#         os: [ubuntu-latest] # [ubuntu-latest, windows-latest, macos-latest]
+#         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+#
+#     steps:
+#     - uses: actions/checkout@v4
+#     - uses: astral-sh/setup-uv@v5
+#       with:
+#         version: "latest"
+#         python-version: ${{ matrix.python-version }}
+#
+#     - name: Install & Test Defaults
+#       run: |
+#         uv pip install ".[test]"
+#         pytest --cov=doorway --color=yes --capture=no --verbose -m 'not extra_test' ./tests/
+#
+#     - name: Install & Test Extras
+#       run: |
+#         uv pip install ".[extras]"
+#         pytest --cov=doorway --color=yes --capture=no --verbose -m 'extra_test' ./tests/
+#
+#     # codecov automatically merges all generated files
+#     - uses: codecov/codecov-action@v1
+#       with:
+#         token: ${{ secrets.CODECOV_TOKEN }}
+#         fail_ci_if_error: false
+
+# # @pytest.mark.remote_test
+# # pytest --color=yes --capture=no --verbose -m 'not remote_test'
+#      # * run pytest on non-remote tests
+#      - id: pytest
+#        run: pytest --color=yes --capture=no --verbose -m 'not remote_test'

.github/workflows/version-bump.yaml

@@ -0,0 +1,18 @@
+
+name: version-bump
+on:
+  pull_request: {types: [closed], branches: [main]}
+jobs:
+  build:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.merge_commit_sha }}
+          fetch-depth: "0"
+      - uses: anothrNick/github-tag-action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DEFAULT_BUMP: "patch"
+          WITH_V: true

.gitignore

@@ -137,4 +137,4 @@ data/
 .idea/
 /lightning_logs/
 *.zip
-*.db
+*.db

.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v2.3.0
+  hooks:
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-added-large-files
+      args: ["--maxkb=500"]
+    - id: check-case-conflict
+    - id: detect-private-key
+
+# - repo: https://github.com/asottile/pyupgrade
+#   rev: v3.19.1
+#   hooks:
+#   - id: pyupgrade
+#     args: [--py39-plus]
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.9.9
+  hooks:
+    - id: ruff
+      args: [ --fix ]
+    - id: ruff-format

README.md

@@ -129,7 +129,7 @@ the `mtgdata.scryfall_convert.generate_converted_dataset` function. Similar argu
 as that of the command line approach.
 
 ```python3
-from mtgdata import generate_converted_dataset 
+from mtgdata import generate_converted_dataset
 
 generate_converted_dataset(
     out_img_type='border_crop',

mtgdata/__init__.py

@@ -1,7 +1,22 @@
+__all__ = (
+    "ScryfallDataset",
+    "ScryfallCardFaceDatasetManager",
+    "ScryfallImageType",
+    "ScryfallBulkType",
+    "Hdf5Dataset",
+    "dataset_save_as_hdf5",
+    "generate_converted_dataset",
+)
 
-from mtgdata.scryfall import ScryfallDataset, ScryfallCardFaceDatasetManager, ScryfallImageType, ScryfallBulkType
+from mtgdata.scryfall import (
+    ScryfallDataset,
+    ScryfallCardFaceDatasetManager,
+    ScryfallImageType,
+    ScryfallBulkType,
+)
 from mtgdata.util.hdf5 import Hdf5Dataset
 
 from mtgdata.scryfall_convert import dataset_save_as_hdf5
+
 # from mtgdata.scryfall_convert import dataset_save_meta
 from mtgdata.scryfall_convert import generate_converted_dataset

mtgdata/__main__.py

@@ -1,32 +1,37 @@
-
-
-if __name__ == '__main__':
+if __name__ == "__main__":
     import argparse
     import logging
     from mtgdata.scryfall import _make_parser_scryfall_prepare, _run_scryfall_prepare
-    from mtgdata.scryfall_convert import _make_parser_scryfall_convert, _run_scryfall_convert
+    from mtgdata.scryfall_convert import (
+        _make_parser_scryfall_convert,
+        _run_scryfall_convert,
+    )
 
     # initialise logging
     logging.basicConfig(level=logging.INFO)
-    YLW = '\033[93m'
-    RST = '\033[0m'
+    YLW = "\033[93m"
+    RST = "\033[0m"
 
     # subcommands
     cli = argparse.ArgumentParser()
     parsers = cli.add_subparsers()
     parsers.required = True
 
     # subcommand: prepare -- add args from scryfall.py
-    parser_prepare = parsers.add_parser('prepare')
-    parser_prepare.set_defaults(_run_fn_=_run_scryfall_prepare, _run_msg_=f'{YLW}preparing...{RST}')
+    parser_prepare = parsers.add_parser("prepare")
+    parser_prepare.set_defaults(
+        _run_fn_=_run_scryfall_prepare, _run_msg_=f"{YLW}preparing...{RST}"
+    )
     _make_parser_scryfall_prepare(parser_prepare)
 
     # subcommand: convert -- add args from scryfall_convert.py
-    parser_convert = parsers.add_parser('convert')
-    parser_convert.set_defaults(_run_fn_=_run_scryfall_convert, _run_msg_=f'{YLW}converting...{RST}')
+    parser_convert = parsers.add_parser("convert")
+    parser_convert.set_defaults(
+        _run_fn_=_run_scryfall_convert, _run_msg_=f"{YLW}converting...{RST}"
+    )
     _make_parser_scryfall_convert(parser_convert)
 
     # run the specified subcommand!
     args = cli.parse_args()
-    print(f'{args._run_msg_}')
+    print(f"{args._run_msg_}")
     args._run_fn_(args)