Skip to content

Commit

Permalink
Pull in upstream fixes and update docs (#202)
Browse files Browse the repository at this point in the history
  • Loading branch information
gaborbernat authored May 11, 2024
1 parent a6e4fec commit 85bcfa1
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 18 deletions.
21 changes: 4 additions & 17 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,14 @@ Calculating max supported Python version
This tool will automatically generate the ``Programming Language :: Python :: 3.X`` classifiers for you. To do so it
needs to know what is the range of Python interpreter versions you support. The lower bound can be deduced by looking
at the ``requires-python`` key in the ``pyproject.toml`` configuration file. For the upper bound by default will
assume the latest stable release when the library is released; however, if you're adding support for a not yet final
Python version the tool offers a functionality that it will invoke ``tox`` for you and inspect the test environments
and use the latest python version tested against. For this to work ``tox`` needs to be on ``PATH``, an easy way to
ensure this is to set ``tox`` as additional dependency via:
assume the latest stable release but can be changed via CLI flag or config:

.. code-block:: yaml
- repo: https://github.com/tox-dev/pyproject-fmt
rev: "1.0.0"
rev: "2.0.0"
hooks:
- id: pyproject-fmt
additional_dependencies: ["tox>=4.9"]
Command line interface
Expand All @@ -67,17 +63,8 @@ The ``tool.pyproject-fmt`` table is used when present in any of the ``pyproject.
# pyproject.toml
[tool.pyproject-fmt]
column_width = 120
indent = 4
keep_full_version = false
min_supported_python = "3.7"
max_supported_python = "3.10"
API
---

.. automodule:: pyproject_fmt
:members:

.. toctree::
:hidden:

self
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ dynamic = [
"version",
]
dependencies = [
"pyproject-fmt-rust==1.0.1",
"pyproject-fmt-rust==1.0.4",
]
optional-dependencies.docs = [
"furo>=2024.5.6",
Expand Down

0 comments on commit 85bcfa1

Please sign in to comment.