Skip to content

Commit

Permalink
Merge branch 'release/1.1.0.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
chdemko committed Dec 17, 2024
2 parents 1c33e1b + 196d808 commit ea94729
Show file tree
Hide file tree
Showing 7 changed files with 155 additions and 25 deletions.
16 changes: 8 additions & 8 deletions .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ jobs:
strategy:
matrix:
python-version: ['3.10', '3.11', '3.12', '3.13']
pandoc-version: ['3.5']
pandoc-version: ['3.6']
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install Hatch
Expand All @@ -37,11 +37,11 @@ jobs:
strategy:
matrix:
python-version: ['3.12']
pandoc-version: [2.11.4, '2.12', '2.13', 2.14.2, '2.15', 2.16.2, 2.17.1.1, '2.18', 2.19.2, 3.0.1, 3.1.13, 3.2.1, '3.3']
pandoc-version: [2.11.4, '2.12', '2.13', 2.14.2, '2.15', 2.16.2, 2.17.1.1, '2.18', 2.19.2, 3.0.1, 3.1.13, 3.2.1, '3.3', '3.4', 3.5, '3.6']
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install Hatch
Expand All @@ -59,11 +59,11 @@ jobs:
strategy:
matrix:
python-version: ['3.12']
pandoc-version: ['3.5']
pandoc-version: ['3.6']
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install Hatch
Expand All @@ -84,11 +84,11 @@ jobs:
strategy:
matrix:
python-version: ['3.12']
pandoc-version: ['3.5']
pandoc-version: ['3.6']
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install Hatch
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install Hatch
Expand Down
6 changes: 6 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,9 @@ repos:
entry: hatch test
language: system
pass_filenames: false
- id: lock
name: lock
entry: uv lock --upgrade
language: system
pass_filenames: false

36 changes: 33 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
Installation
============

[![Python package](https://github.com/chdemko/pandoc-beamer-block/workflows/Python%20package/badge.svg?branch=develop)](https://github.com/chdemko/pandoc-beamer-block/actions/workflows/python-package.yml)
[![Python package](https://img.shields.io/github/actions/workflow/status/chdemko/pandoc-beamer-block/python-package.yml?logo=github&branch=develop)](https://github.com/chdemko/pandoc-beamer-block/actions/workflows/python-package.yml)
[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://pypi.org/project/black/)
[![Coveralls](https://img.shields.io/coveralls/github/chdemko/pandoc-beamer-block/develop.svg?logo=Codecov&logoColor=white)](https://coveralls.io/github/chdemko/pandoc-beamer-block?branch=develop)
[![Scrutinizer](https://img.shields.io/scrutinizer/g/chdemko/pandoc-beamer-block.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/chdemko/pandoc-beamer-block/)
[![Code Climate](https://codeclimate.com/github/chdemko/pandoc-beamer-block/badges/gpa.svg)](https://codeclimate.com/github/chdemko/pandoc-beamer-block/)
[![Code Climate](https://img.shields.io/codeclimate/maintainability/chdemko/pandoc-beamer-block?logo=codeclimate&barnch=develop)](https://codeclimate.com/github/chdemko/pandoc-beamer-block/)
[![CodeFactor](https://img.shields.io/codefactor/grade/github/chdemko/pandoc-beamer-block/develop.svg?logo=codefactor)](https://www.codefactor.io/repository/github/chdemko/pandoc-beamer-block)
[![Codacy](https://img.shields.io/codacy/grade/af5a670790264990811713280a8f8dcf.svg?logo=codacy&logoColor=white)](https://app.codacy.com/gh/chdemko/pandoc-beamer-block/dashboard)
[![PyPI version](https://img.shields.io/pypi/v/pandoc-beamer-block.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-beamer-block/)
Expand All @@ -16,7 +16,7 @@ Installation
[![Downloads](https://img.shields.io/pypi/dm/pandoc-beamer-block?logo=pypi&logoColor=white)](https://pepy.tech/project/pandoc-beamer-block)
[![Development Status](https://img.shields.io/pypi/status/pandoc-beamer-block.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-beamer-block/)
[![Python version](https://img.shields.io/pypi/pyversions/pandoc-beamer-block.svg?logo=Python&logoColor=white)](https://pypi.org/project/pandoc-beamer-block/)
[![Pandoc version](https://img.shields.io/badge/pandoc-2.11%20|%202.12%20|%202.13%20|%202.14%20|%202.15%20|%202.16%20|%202.17%20|%202.18%20|%202.19%20|%203.0%20|%203.1%20|%203.2%20|%203.3%20|%203.4%20|%203.5-blue.svg?logo=markdown)](https://pandoc.org/)
[![Pandoc version](https://img.shields.io/badge/pandoc-2.11%20..%203.6-blue.svg?logo=markdown)](https://pandoc.org/)
[![Latest release](https://img.shields.io/github/release-date/chdemko/pandoc-beamer-block.svg?logo=github)](https://github.com/chdemko/pandoc-beamer-block/releases)
[![Last commit](https://img.shields.io/github/last-commit/chdemko/pandoc-beamer-block/develop?logo=github)](https://github.com/chdemko/pandoc-beamer-block/commit/develop/)
[![Repo Size](https://img.shields.io/github/repo-size/chdemko/pandoc-beamer-block.svg?logo=github)](http://pandoc-beamer-block.readthedocs.io/en/latest/)
Expand Down Expand Up @@ -64,3 +64,33 @@ If you have any difficulties with pandoc-beamer-block, please feel welcome to

[file an issue]: https://github.com/chdemko/pandoc-beamer-block/issues

Contribute
==========

Instructions
------------

Install `hatch`, then run

~~~shell-session
$ hatch run pip install pre-commit
$ hatch run pre-commit install
~~~

to install `pre-commit` before working on your changes.

Tests
-----

When your changes are ready, run

~~~shell-session
$ hatch test
$ hatch fmt --check
$ hatch run lint:check
$ hatch run docs:build
$ hatch build -t wheel
~~~

for running the tests, checking the style, building the documentation
and building the wheel.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
version = os.popen("hatch version").readline().strip() # noqa: S605, S607
year = datetime.datetime.now(tz=datetime.UTC).date().year
# noinspection PyShadowingBuiltins
copyright = f"2019-{year}, {author}" # noqa: A001
copyright = f"2018-{year}, {author}" # noqa: A001

python_path = str(Path("..").resolve())
sys.path.insert(0, python_path)
Expand Down
27 changes: 15 additions & 12 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ source = "vcs"

[tool.hatch.version.raw-options]
version_scheme = "no-guess-dev"
local_scheme = "node-and-date"
local_scheme = "no-local-version"

[tool.hatch.build.targets.wheel]
packages = ["src/pandoc_beamer_block"]
Expand All @@ -72,7 +72,7 @@ dependencies = [
"black[jupyter]~=24.10",
# Style checkers
"doc8~=1.1",
"mypy~=1.12",
"mypy~=1.13",
"flake8~=7.1",
"flake8-pyproject~=1.2",
"flake8-annotations-complexity~=0.0",
Expand Down Expand Up @@ -151,6 +151,7 @@ pythonpath = ["src"]
[tool.ruff]
# Allow lines to be as long as 88.
line-length = 88
target-version = "py310"

[tool.flake8]
# flake8-docstrings
Expand Down Expand Up @@ -211,21 +212,23 @@ arg-type-hints-in-docstring = false
style = "numpy"

[tool.mypy]
disallow_any_generics = true
disallow_subclassing_any = true
# disallow_untyped_calls = true
# disallow_untyped_defs = true
# disallow_incomplete_defs = true
# check_untyped_defs = true
disallow_untyped_decorators = true
ignore_missing_imports = true
no_implicit_optional = true
no_implicit_reexport = true
warn_redundant_casts = true
warn_return_any = true
# equivalent to --strict option
warn_unused_configs = true
disallow_any_generics = true
disallow_subclassing_any = true
disallow_untyped_calls = true
disallow_untyped_defs = true
disallow_incomplete_defs = true
check_untyped_defs = true
disallow_untyped_decorators = true
warn_redundant_casts = true
warn_unused_ignores = true
warn_return_any = true
no_implicit_reexport = true
strict_equality = true
extra_checks = true
mypy_path = "src"

[[tool.mypy.overrides]]
Expand Down
Loading

0 comments on commit ea94729

Please sign in to comment.