diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index ba7dee6..ec9bb4a 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,7 +1,7 @@ --- repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: trailing-whitespace exclude: tests(/\w*)*/functional/t/trailing_whitespaces.py|tests/pyreverse/data/.*.html|doc/data/messages/t/trailing-whitespace/bad.py @@ -15,25 +15,25 @@ repos: - repo: https://github.com/astral-sh/ruff-pre-commit # Ruff version. - rev: 'v0.0.290' + rev: 'v0.3.0' hooks: - id: ruff args: [ "--fix" ] # https://github.com/python/black#version-control-integration - repo: https://github.com/psf/black - rev: 23.9.1 + rev: 24.2.0 hooks: - id: black-jupyter - repo: https://github.com/pre-commit/mirrors-mypy - rev: v1.5.1 + rev: v1.8.0 hooks: - id: mypy # Other Linters - repo: https://github.com/adrienverge/yamllint.git - rev: v1.32.0 + rev: v1.35.1 hooks: - id: yamllint args: ["-d {extends: relaxed, rules: {line-length: {max: 120}}}"] diff --git a/CHANGELOG.md b/CHANGELOG.md index d2a5c5b..f1a5caf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - [issue/13](https://github.com/danielfromearth/batchee/issues/13): Add simple command line interface for testing - [issue/16](https://github.com/danielfromearth/batchee/issues/16): Add a logo - [PR #75](https://github.com/danielfromearth/batchee/pull/75): Add Docker build steps to GitHub Actions workflow +- [PR #84](https://github.com/danielfromearth/batchee/pull/84): Add readme badges ### Changed - [issue/11](https://github.com/danielfromearth/batchee/issues/11): Rename from concat_batcher to batchee - [issue/21](https://github.com/danielfromearth/batchee/issues/21): Improve CICD workflows diff --git a/README.md b/README.md index 0811fa8..3729245 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,22 @@ -[](stitchee_9_hex) +

+ batchee, a python package for grouping together filenames to enable subsequent batched operations (such as concatenation). +

+ +

+ + Project Status: Active – The project has reached a stable, usable state and is being actively developed + + + Code style + + + Mypy checked + +

+ +[//]: # (Using deprecated `align="center"` for the logo image and badges above, because of https://stackoverflow.com/a/62383408) # Overview