feat: switch from setup.cfg to pyproject.toml + hatchling

This commit is contained in:
Lance Edgar 2024-07-01 11:03:11 -05:00
parent 95e89a6081
commit 3af49e2e62
5 changed files with 71 additions and 128 deletions

3
.gitignore vendored
View file

@ -1,3 +1,6 @@
*~
*.pyc
dist/
rattail_tutorial.egg-info/ rattail_tutorial.egg-info/
docs/_build/ docs/_build/
.tox/ .tox/

60
pyproject.toml Normal file
View file

@ -0,0 +1,60 @@
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[project]
name = "rattail-tutorial"
version = "0.1.0"
description = "Rattail Development Tutorial"
readme = "README.rst"
authors = [{name = "Lance Edgar", email = "lance@edbob.org"}]
license = {text = "GNU GPL v3+"}
classifiers = [
"Development Status :: 3 - Alpha",
"Environment :: Console",
"Environment :: Web Environment",
"Framework :: Pyramid",
"Intended Audience :: Developers",
"Natural Language :: English",
"Operating System :: POSIX :: Linux",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Topic :: Office/Business",
]
dependencies = [
"invoke",
"psycopg2",
"rattail[auth,db,bouncer]",
"Tailbone",
"tox",
]
[project.scripts]
rattail_tutorial = "rattail_tutorial.commands:main"
[project.entry-points."paste.app_factory"]
main = "rattail_tutorial.web.app:main"
[project.entry-points."rattail.config.extensions"]
rattail_tutorial = "rattail_tutorial.config:Rattail_tutorialConfig"
[project.entry-points."rattail_tutorial.subcommands"]
hello = "rattail_tutorial.commands:HelloWorld"
[project.urls]
Homepage = "https://rattailproject.org"
repository = "https://kallithea.rattailproject.org/rattail-project/rattail-tutorial"
Changelog = "https://kallithea.rattailproject.org/rattail-project/rattail-tutorial/files/master/CHANGELOG.md"
[tool.commitizen]
version_provider = "pep621"
tag_format = "v$version"
update_changelog_on_bump = true

View file

@ -1,3 +1,6 @@
# -*- coding: utf-8; -*- # -*- coding: utf-8; -*-
__version__ = '0.1.0' from importlib.metadata import version
__version__ = version('rattail-tutorial')

118
setup.py
View file

@ -1,118 +0,0 @@
# -*- coding: utf-8; -*-
################################################################################
#
# Rattail -- Retail Software Framework
# Copyright © 2010-2019 Lance Edgar
#
# This file is part of Rattail.
#
# Rattail is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# Rattail is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# Rattail. If not, see <http://www.gnu.org/licenses/>.
#
################################################################################
"""
Rattail Tutorial setup script
"""
import os
from setuptools import setup, find_packages
here = os.path.abspath(os.path.dirname(__file__))
exec(open(os.path.join(here, 'rattail_tutorial', '_version.py')).read())
README = open(os.path.join(here, 'README.rst')).read()
requires = [
#
# Version numbers within comments below have specific meanings.
# Basically the 'low' value is a "soft low," and 'high' a "soft high."
# In other words:
#
# If either a 'low' or 'high' value exists, the primary point to be
# made about the value is that it represents the most current (stable)
# version available for the package (assuming typical public access
# methods) whenever this project was started and/or documented.
# Therefore:
#
# If a 'low' version is present, you should know that attempts to use
# versions of the package significantly older than the 'low' version
# may not yield happy results. (A "hard" high limit may or may not be
# indicated by a true version requirement.)
#
# Similarly, if a 'high' version is present, and especially if this
# project has laid dormant for a while, you may need to refactor a bit
# when attempting to support a more recent version of the package. (A
# "hard" low limit should be indicated by a true version requirement
# when a 'high' version is present.)
#
# In any case, developers and other users are encouraged to play
# outside the lines with regard to these soft limits. If bugs are
# encountered then they should be filed as such.
#
# package # low high
'invoke', # 1.3.0
'psycopg2', # 2.6.2
'rattail[auth,db,bouncer]', # 0.7.25
'Tailbone', # 0.5.29
'tox', # 3.13.2
]
setup(
name = "rattail-tutorial",
version = __version__,
author = "Lance Edgar",
author_email = "lance@edbob.org",
url = "https://rattailproject.org",
license = "GNU GPL v3",
description = "Rattail Development Tutorial",
long_description = README,
classifiers = [
'Development Status :: 3 - Alpha',
'Environment :: Console',
'Environment :: Web Environment',
'Framework :: Pyramid',
'Intended Audience :: Developers',
'Natural Language :: English',
'Operating System :: POSIX :: Linux',
'Programming Language :: Python',
'Programming Language :: Python :: 3',
'Topic :: Office/Business',
],
install_requires = requires,
packages = find_packages(),
include_package_data = True,
entry_points = {
'rattail.config.extensions': [
'rattail_tutorial = rattail_tutorial.config:Rattail_tutorialConfig',
],
'console_scripts': [
'rattail_tutorial = rattail_tutorial.commands:main',
],
'rattail_tutorial.commands': [
'hello = rattail_tutorial.commands:HelloWorld',
],
'paste.app_factory': [
'main = rattail_tutorial.web.app:main',
],
},
)

View file

@ -2,7 +2,7 @@
################################################################################ ################################################################################
# #
# Rattail -- Retail Software Framework # Rattail -- Retail Software Framework
# Copyright © 2010-2019 Lance Edgar # Copyright © 2010-2024 Lance Edgar
# #
# This file is part of Rattail. # This file is part of Rattail.
# #
@ -24,20 +24,15 @@
Tasks for 'rattail-tutorial' package Tasks for 'rattail-tutorial' package
""" """
import os
from invoke import task from invoke import task
here = os.path.abspath(os.path.dirname(__file__))
exec(open(os.path.join(here, 'rattail_tutorial', '_version.py')).read())
@task @task
def release(c): def release(c):
""" """
Release a new version of `rattail-tutorial`. Release a new version of `rattail-tutorial`.
""" """
c.run('rm -rf rattail_tutorial.egg-info') c.run('rm -rf rattail_tutorial.egg-info')
c.run('python setup.py sdist --formats=gztar') c.run('rm -rf dist')
c.run('twine upload dist/rattail-tutorial-{}.tar.gz'.format(__version__)) c.run('python -m build --sdist')
c.run('twine upload dist/*')