Skip to content

Commit

Permalink
Documentation updates and bring Poetry config to the same state as se…
Browse files Browse the repository at this point in the history
…tuptools.
  • Loading branch information
bartTC committed Aug 13, 2024
1 parent a59b038 commit 6436ade
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 6 deletions.
4 changes: 2 additions & 2 deletions PACKAGING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Packaging quick reminder

Make sure maintainer dependencies are installed::

pip install -e .[maintainer,dev]
poetry install

Run release command and follow prompt instructions::

fullrelease
poetry run fullrelease
6 changes: 5 additions & 1 deletion TESTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,9 @@ the libraries to build PIL, too. Here's the Ubuntu commands::
sudo apt-get install build-essential python-dev python3-dev
sudo apt-get install libjpeg8-dev zlib1g-dev

Here's the OSX Homebrew command:

brew install libjpeg libtiff little-cms2 openjpeg webp

Finally, just run ``tox``!
If you want, you can test against a specific version like this: ``tox -e py36``
If you want, you can test against a specific version like this: ``tox -e py312-pil``
47 changes: 44 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,38 @@ packages = [{include = "qrcode"}]
description = "QR Code image generator"
authors = ["Lincoln Loop <[email protected]>"]
license = "BSD"
readme = "README.rst"
readme = ["README.rst", "CHANGES.rst"]
homepage = "https://github.com/lincolnloop/python-qrcode"
keywords = ["qr", "denso-wave", "IEC18004"]
classifiers = [
"Development Status :: 5 - Production/Stable",
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
"Intended Audience :: Developers",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3 :: Only",
"Topic :: Multimedia :: Graphics",
"Topic :: Software Development :: Libraries :: Python Modules",
]

# There is no support for data files yet.
# https://github.com/python-poetry/poetry/issues/9519
#
# data_files = [
# { destination = "share/man/man1", from = [ "doc/qr.1" ] },
# ]

[tool.poetry.scripts]
qr = 'qrcode.console_scripts:main'


[tool.poetry.dependencies]
python = "^3.7"
python = "^3.9"
colorama = {version = "*", platform = "win32"}
pypng = "*"
pillow = {version = ">=9.1.0", optional = true}
Expand All @@ -22,4 +50,17 @@ pil = ["pillow"]

[tool.poetry.group.dev.dependencies]
pytest = {version = "*"}
pytest-cov = {version = "*"}
pytest-cov = {version = "*"}
docutils = "^0.21.2"
zest-releaser = {extras = ["recommended"], version = "^9.2.0"}

[tool.zest-releaser]
less-zeros = "yes"
version-levels = 2
tag-format = "v{version}"
tag-message = "Version {version}"
tag-signing = "yes"
date-format =" %%-d %%B %%Y"
prereleaser.middle = [
"qrcode.release.update_manpage"
]

0 comments on commit 6436ade

Please sign in to comment.