Skip to content

Readme badges and pyproject cleanup #3378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Readme badges and pyproject cleanup #3378

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d27dd09
Update project metadata
martinhoyer Nov 25, 2024
798869f
Add badges to README
martinhoyer Nov 25, 2024
95ec75e
fixup! Add badges to README
martinhoyer Apr 10, 2025
fccf8da
fixup! Add badges to README
martinhoyer Apr 10, 2025
be25bee
Update README.rst
thrix Apr 17, 2025
cee91bc
Bump dependency versions to latest c9s rpms
martinhoyer Apr 23, 2025
10db97e
Removing ruff, pre-commit badges
martinhoyer Apr 23, 2025
48dbd27
squash: actually remove the ruff and pre-commit badges
martinhoyer Apr 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,23 @@ repos:
#
# For now, we simply copy & paste from pyproject.toml :(
additional_dependencies:
- "click>=8.0.3,!=8.1.4" # 8.1.3 / 8.1.6 TODO type annotations tmt.cli.Context -> click.core.Context click/issues/2558
- "docutils>=0.16" # 0.16 is the current one available for RHEL9
- "fmf>=1.3.0"
- "jinja2>=2.11.3" # 3.1.2 / 3.1.2
- "packaging>=20" # 20 seems to be available with RHEL8
- "pint>=0.16.1" # 0.16.1
- "click>=8.0.3"
- "docutils>=0.16"
- "fmf>=1.7.0"
- "jinja2>=2.11.3"
- "packaging>=20"
- "pint>=0.16.1"
- "pydantic>=1.10.14"
- "pygments>=2.7.4" # 2.7.4 is the current one available for RHEL9
- "requests>=2.25.1" # 2.28.2 / 2.31.0
- "ruamel.yaml>=0.16.6" # 0.17.32 / 0.17.32
- "urllib3>=1.26.5, <2.0" # 1.26.16 / 2.0.4
- "pygments>=2.7.4"
- "requests>=2.25.1"
- "ruamel.yaml>=0.16.6"
- "urllib3>=1.26.5, <2.0"
- "jira>=3.5.0, <4"

# report-junit
- "lxml>=4.6.5"

- "typing-extensions>=4.9.0; python_version < '3.13'"
- "typing-extensions>=4.12.2; python_version < '3.13'"
- "pytest"
- "requre"
# Do not install *types-click* - it's not recommended with Click 8 & newer,
Expand Down Expand Up @@ -75,17 +75,17 @@ repos:
#
# For now, we simply copy & paste from pyproject.toml :(
additional_dependencies:
- "click>=8.0.3,!=8.1.4" # 8.1.3 / 8.1.6 TODO type annotations tmt.cli.Context -> click.core.Context click/issues/2558
- "docutils>=0.16" # 0.16 is the current one available for RHEL9
- "fmf>=1.3.0"
- "jinja2>=2.11.3" # 3.1.2 / 3.1.2
- "packaging>=20" # 20 seems to be available with RHEL8
- "pint>=0.16.1" # 0.16.1 / 0.19.x TODO: Pint 0.20 requires larger changes to tmt.hardware
- "click>=8.0.3"
- "docutils>=0.16"
- "fmf>=1.7.0"
- "jinja2>=2.11.3"
- "packaging>=20"
- "pint>=0.16.1"
- "pydantic>=1.10.14"
- "pygments>=2.7.4" # 2.7.4 is the current one available for RHEL9
- "requests>=2.25.1" # 2.28.2 / 2.31.0
- "ruamel.yaml>=0.16.6" # 0.17.32 / 0.17.32
- "urllib3>=1.26.5, <2.0" # 1.26.16 / 2.0.4
- "pygments>=2.7.4"
- "requests>=2.25.1"
- "ruamel.yaml>=0.16.6"
- "urllib3>=1.26.5, <2.0"
- "jira>=3.5.0, <4"

# report-junit
Expand Down
30 changes: 30 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
tmt - Test Management Tool
==================================================================

|docs| |matrix| |fedora-pkg| |copr-build| |pypi-version| |python-versions| |license|

The ``tmt`` tool provides a user-friendly way to work with tests.
You can comfortably create new tests, safely and easily run tests
across different environments, review test results, debug test
Expand All @@ -21,3 +23,31 @@ inheritance and elasticity metadata are organized in the structure
efficiently, preventing unnecessary duplication.

See the https://tmt.readthedocs.io web for detailed documentation.

.. |docs| image:: https://img.shields.io/badge/Read%20the%20Docs-8CA1AF?logo=readthedocs&logoColor=fff
:target: https://tmt.readthedocs.io/
:alt: Documentation

.. |matrix| image:: https://img.shields.io/badge/Matrix-000?logo=matrix&logoColor=fff
:target: https://matrix.to/#/#tmt:fedoraproject.org
:alt: Matrix chat

.. |fedora-pkg| image:: https://img.shields.io/fedora/v/tmt?logo=fedora&logoColor=fff&color=fff&labelColor=51a2da
:target: https://src.fedoraproject.org/rpms/tmt
:alt: Fedora package

.. |copr-build| image:: https://img.shields.io/badge/dynamic/json?color=blue&label=Copr&query=builds.latest.state&url=https%3A%2F%2Fcopr.fedorainfracloud.org%2Fapi_3%2Fpackage%3Fownername%3D%40teemtee%26projectname%3Dlatest%26packagename%3Dtmt%26with_latest_build%3DTrue
:target: https://copr.fedorainfracloud.org/coprs/g/teemtee/stable/
:alt: Copr build status

.. |pypi-version| image:: https://img.shields.io/badge/PyPI-3775A9?logo=pypi&logoColor=fff
:target: https://pypi.org/project/tmt/
:alt: PyPI

.. |python-versions| image:: https://img.shields.io/pypi/pyversions/tmt
:target: https://pypi.org/project/tmt/
:alt: Python versions

.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://opensource.org/licenses/MIT
:alt: MIT License
38 changes: 20 additions & 18 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,44 +24,46 @@ classifiers = [
"License :: OSI Approved :: MIT License",
"Natural Language :: English",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Topic :: Utilities",
"Topic :: Software Development :: Testing",
"Operating System :: POSIX :: Linux",
]
dependencies = [ # F39 / PyPI
"click>=8.0.3,!=8.1.4", # 8.1.3 / 8.1.6 TODO type annotations tmt.cli.Context -> click.core.Context click/issues/2558
"docutils>=0.16", # 0.16 is the current one available for RHEL9
dependencies = [
# Minimal versions based on c9s rpms
"click>=8.0.3",
"docutils>=0.16",
"fmf>=1.7.0",
"jinja2>=2.11.3", # 3.1.2 / 3.1.2
"packaging>=20", # 20 seems to be available with RHEL8
"pint>=0.16.1", # 0.16.1
"jinja2>=2.11.3",
"packaging>=20.9",
"pint>=0.16.1",
"pydantic>=1.10.14",
"pygments>=2.7.4", # 2.7.4 is the current one available for RHEL9
"requests>=2.25.1", # 2.28.2 / 2.31.0
"ruamel.yaml>=0.16.6", # 0.17.32 / 0.17.32
"urllib3>=1.26.5, <3.0", # 1.26.16 / 2.0.4
"typing-extensions>=4.9.0; python_version < '3.13'",
"pygments>=2.7.4",
"requests>=2.25.1",
"ruamel.yaml>=0.16.6",
"urllib3>=1.26.5, <3.0",
"typing-extensions>=4.12.2; python_version < '3.13'",
]

[project.optional-dependencies]
ansible = [
"ansible-core",
"ansible-core>=2.14.18",
]
test-convert = [
"html2text>=2020.1.16",
"markdown>=3.3.4",
"nitrate>=1.8.2",
"nitrate>=1.9.0",
"python-bugzilla>=3.2.0",
]
export-polarion = [
"pylero>=0.0.8",
"pylero>=0.1.0",
]
provision-beaker = [
"mrack>=1.23.1",
"mrack>=1.23.3",
]
provision-virtual = [
"testcloud>=0.11.3",
"testcloud>=0.11.7",
]
provision-container = []
provision-bootc = []
Expand Down Expand Up @@ -182,7 +184,7 @@ template = "dev"
description = "Run scripts with multiple Python versions"

[[tool.hatch.envs.test.matrix]]
python = ["3.9", "3.11", "3.12"]
python = ["3.9", "3.12", "3.13"]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@martinhoyer I believe this is a significant change, it would desire it's own MR, ideally with the pyproject.yaml changes. Seems to be now hidden, I need to read the comments to find out.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thrix hmm, afaik this is not being used in any pipeline and only affects hatch run test:foo, isn't it?


[tool.hatch.envs.docs]
dependencies = ["tmt[docs]"]
Expand Down