Skip to content

Commit

Permalink
update tooling, update readme, begin v1 beta push
Browse files Browse the repository at this point in the history
  • Loading branch information
boldandbrad committed Feb 25, 2024
1 parent 2815708 commit ffb9d06
Show file tree
Hide file tree
Showing 8 changed files with 60 additions and 47 deletions.
2 changes: 0 additions & 2 deletions .flake8

This file was deleted.

8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ __pycache__/
build/
dist/

# tool cache
.mypy_cache
.pytest_cache
.ruff_cache

# test
.coverage
coverage.xml

# homebrew
formula.rb
33 changes: 12 additions & 21 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,29 +9,26 @@ repos:
- id: check-yaml
- id: check-toml
- id: check-added-large-files
- repo: https://github.com/charliermarsh/ruff-pre-commit
rev: v0.1.6
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.2.2
hooks:
# run the linter
- 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
# run the formatter
- id: ruff-format
- repo: https://github.com/dosisod/refurb
rev: v1.28.0
hooks:
- id: isort
- id: refurb
# additional_dependencies:
# - mypy<1.7 # SEE: https://github.com/dosisod/refurb/issues/305
- repo: https://github.com/python-jsonschema/check-jsonschema
rev: 0.27.1
rev: 0.28.0
hooks:
- id: check-github-workflows
- repo: https://github.com/gitleaks/gitleaks
rev: v8.18.1
rev: v8.18.2
hooks:
- id: gitleaks
# - repo: https://github.com/pre-commit/mirrors-prettier
Expand All @@ -43,9 +40,3 @@ repos:
# 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
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

# euchre-cli

[![build status](https://img.shields.io/github/actions/workflow/status/boldandbrad/euchre-cli/python-test.yml?branch=main&logo=github)]
[![build status](https://img.shields.io/github/actions/workflow/status/boldandbrad/euchre-cli/python-test.yml?branch=main&logo=github)](https://github.com/boldandbrad/euchre-cli/actions/workflows/python-test.yml?query=branch%3Amain+)
[![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/)
[![PyPI](https://img.shields.io/pypi/v/euchre-cli)](https://pypi.org/project/euchre-cli/)
Expand All @@ -25,7 +25,7 @@

* James Barbret - logo design

## Planned Features
## Roadmap

### Release 1.x

Expand All @@ -45,6 +45,7 @@

### Future

* TUI version
* Play multiple cards at once if they are the highest remaining cards
* Ability to go alone
* Go alone with help mode
Expand All @@ -55,4 +56,10 @@
* 'Ace no face' mode
* Three handed euchre mode
* Install with homebrew on mac and linux ?
* Install with Chocolatey on windows ?
* Install with Chocolatey/Scoop on windows ?

### Probably never but would be cool, right? 🤷

* Ability to connect to and play with your friends online
* Integrate this into a larger tool called "cards-cli" or something with other
available card games.
9 changes: 9 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ and this project adheres to

## Unreleased

### Added

- Add Readme build-status badge link to github actions

### Updated

- Further consolidate dev tooling with ruff
- Update Roadmap in Readme

## [0.7.0] - 2024-02-19

### Added
Expand Down
27 changes: 17 additions & 10 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,39 @@
venv:
. .venv/bin/activate

# install euchre-cli from local
install:
pip install -q ."[test]"
# install dev dependencies
dev-deps:
pip install ."[dev]"

# install euchre-cli via flit
flit-install:
pip install flit
flit install
# install test dependencies
test-deps:
pip install ."[test]"

# install euchre-cli from local
install: dev-deps
pip install .

# install editable
dev-install:
pip install -q -e .

# install euchre-cli via flit
flit-install: dev-deps
flit install

# lint and format
lint:
pre-commit run --show-diff-on-failure --all-files

# run all tests
test: install
test: test-deps
pytest

# run all tests with coverage
test-cov: install
test-cov: test-deps
pytest -v --cov-report xml --cov euchre

# build dist
# build distribution
build:
flit build

Expand Down
13 changes: 3 additions & 10 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,26 +30,19 @@ test = [
"pytest-mock",
]
dev = [
"black",
"flake8",
"flit",
"isort",
"ruff",
"refurb",
"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]
[tool.ruff.lint]
# Never enforce `E501` (line length violations).
ignore = ["E501"]
2 changes: 1 addition & 1 deletion src/euchre/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Play euchre in your terminal."""

# release version
__version__ = "0.7.0"
__version__ = "1.0.0b1"

0 comments on commit ffb9d06

Please sign in to comment.