Feat/update ci

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+extend-ignore = D1, D2, E1, E2, E3, E501, W1, W2, W3, W5

.github/workflows/python-publish.yml

@@ -0,0 +1,38 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Publish Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install dependencies via pip
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install flit
+      - name: Build package via flit
+        run: flit build
+      - name: Publish package to pypi
+        # nosemgrep
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/python-test.yml

@@ -0,0 +1,45 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Test Python Package
+
+on:
+  push:
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Run linters via pre-commit
+        # nosemgrep
+        uses: pre-commit/[email protected]
+      - name: Install dependencies via pip
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install flit
+      - name: Install package via flit
+        run: |
+          flit install
+      - name: Run tests via pytest
+        run: |
+          pytest -v --cov-report xml --cov euchre
+      - name: Upload test coverage to Codecov
+        # nosemgrep
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          fail_ci_if_error: true
+          verbose: true

.gitignore

@@ -12,6 +12,7 @@
 .python-version
 .node-version
 .venv
+.envrc
 
 # python artifacts
 __pycache__/

.pre-commit-config.yaml

@@ -0,0 +1,51 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.1.6
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+  - repo: https://github.com/psf/black
+    rev: 23.11.0
+    hooks:
+      - id: black
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.27.1
+    hooks:
+      - id: check-github-workflows
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.18.1
+    hooks:
+      - id: gitleaks
+  # - repo: https://github.com/pre-commit/mirrors-prettier
+  #   rev: v3.1.0
+  #   hooks:
+  #     - id: prettier
+  # - repo: https://github.com/returntocorp/semgrep
+  #   rev: v1.50.0
+  #   hooks:
+  #     - id: semgrep
+  #       args: ["--config", "auto", "--error", "--skip-unknown-extensions"]
+  - repo: https://github.com/dosisod/refurb
+    rev: v1.24.0
+    hooks:
+      - id: refurb
+        # additional_dependencies:
+        #   - mypy<1.7 # SEE: https://github.com/dosisod/refurb/issues/305

README.md

@@ -5,9 +5,9 @@
 
 # euchre-cli
 
-[![Build Status](https://api.travis-ci.com/boldandbrad/euchre-cli.svg?branch=main)](https://travis-ci.com/github/boldandbrad/euchre-cli)
+[![build status](https://img.shields.io/github/actions/workflow/status/boldandbrad/euchre-cli/python-test.yml?branch=main&logo=github)]
 [![codecov](https://codecov.io/gh/boldandbrad/euchre-cli/branch/main/graph/badge.svg)](https://codecov.io/gh/boldandbrad/euchre-cli)
-[![Docs](https://img.shields.io/website?down_message=down&label=docs&up_message=online&url=https%3A%2F%2Fboldandbrad.github.io%2Feuchre-cli%2F)](https://boldandbrad.github.io/euchre-cli/)
+[![docs](https://img.shields.io/website?down_message=down&label=docs&up_message=online&url=https%3A%2F%2Fboldandbrad.github.io%2Feuchre-cli%2F)](https://boldandbrad.github.io/euchre-cli/)
 [![PyPI](https://img.shields.io/pypi/v/euchre-cli)](https://pypi.org/project/euchre-cli/)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/euchre-cli)
 

docs/_coverpage.md

@@ -1,7 +1,7 @@
 
 [<img src="_media/logo_light.png" alt="logo" width="200"/>](/)
 
-# [**euchre-cli** **<small>0.6.1</small>**](/)
+# [**euchre-cli** **<small>0.7.0</small>**](/)
 
 > Play euchre in your terminal.
 

docs/changelog.md

@@ -7,6 +7,27 @@ The format is based on
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html "Semantic Versioning").
 
+## Unreleased
+
+## [0.7.0] - 2024-02-19
+
+### Added
+
+- Add pre-commit hooks
+- Support for python versions 3.11 and 3.12
+
+### Updated
+
+- Replace Travis CI build system with GitHub Actions
+- Replace Setup.py with pyproject.toml built with flit
+- Move `euchre` dir into `src`
+- Rename `src/euchre.py` to `src/root.py`
+- Cleanup code formatting
+
+### Removed
+
+- Remove support for python versions 3.8 and 3.9
+
 ## [0.6.1] - 2022-02-23
 
 ### Fixed

docs/index.html

@@ -43,4 +43,4 @@
   <script src="//unpkg.com/docsify-footer-enh/dist/docsify-footer-enh.min.js"></script>
 </body>
 
-</html>
+</html>

docs/install.md

@@ -2,7 +2,7 @@
 
 Start playing euchre in your terminal.
 
-> Note: The latest version of **euchre-cli** is compatible with `python 3.8+`
+> Note: The latest version of **euchre-cli** is compatible with `python 3.10+`
 > on macOS, Windows, and Linux.
 
 Install with pip.

justfile

@@ -0,0 +1,49 @@
+# activate venv
+venv:
+    . .venv/bin/activate
+
+# install euchre-cli from local
+install:
+    pip install -q ."[test]"
+
+# install euchre-cli via flit
+flit-install:
+    pip install flit
+    flit install
+
+# install editable
+dev-install:
+    pip install -q -e .
+
+# lint and format
+lint:
+    pre-commit run --show-diff-on-failure --all-files
+
+# run all tests
+test: install
+    pytest
+
+# run all tests with coverage
+test-cov: install
+    pytest -v --cov-report xml --cov euchre
+
+# build dist
+build:
+    flit build
+
+# generate homebrew formula
+brew:
+    pip install -q ."[dev]"
+    poet -f euchre-cli >> formula.rb
+
+# remove artifacts
+# TODO: remove __pycache__ dirs from src/ and tests/
+cleanup:
+    rm -f .coverage
+    rm -f coverage.xml
+    rm -f formula.rb
+    rm -rf .pytest_cache
+    rm -rf build
+    rm -rf dist
+    rm -rf *.egg-info
+    rm -rf .ruff_cache

pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "euchre-cli"
+authors = [{ name = "Bradley Wojcik", email = "[email protected]" }]
+readme = "README.md"
+license = { file = "LICENSE" }
+classifiers = ["License :: OSI Approved :: MIT License"]
+requires-python = ">=3.10"
+dynamic = ["version", "description"]
+dependencies = [
+  "click >=8",
+  "names ==0.3.0",
+  "loguru >=0.5.0",
+]
+
+[project.scripts]
+euchre = "euchre.root:cli"
+
+[project.urls]
+Home = "https://boldandbrad.github.io/euchre-cli/"
+Source = "https://github.com/boldandbrad/euchre-cli"
+
+[project.optional-dependencies]
+test = [
+  "pytest >=6",
+  "pytest-cov",
+  "pytest-mock",
+]
+dev = [
+  "black",
+  "flake8",
+  "flit",
+  "isort",
+  "pre-commit",
+  "homebrew-pypi-poet",
+  "refurb",
+]
+
+[tool.flit.module]
+name = "euchre"
+
+[tool.isort]
+profile = "black"
+skip = ["src/euchre/abstract/__init__.py"]
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+testpaths = ["tests"]
+
+[tool.ruff]
+# Never enforce `E501` (line length violations).
+ignore = ["E501"]