Merge pull request #156 from maxmind/greg/build-improvements

Modernize package building

Author: marselester

.readthedocs.yaml

@@ -4,3 +4,8 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.11"
+
+python:
+  install:
+    - method: pip
+      path: .

MANIFEST.in

@@ -1,2 +1,3 @@
+exclude .* .github/**/* dev-bin/*
 include HISTORY.rst README.rst LICENSE geoip2/py.typed tests/*.py tests/data/test-data/*.mmdb
 graft docs/html

dev-bin/release.sh

@@ -37,6 +37,7 @@ fi
 pip install sphinx wheel
 
 perl -pi -e "s/(?<=__version__ = \").+?(?=\")/$version/gsm" geoip2/__init__.py
+perl -pi -e "s/(?<=^version = \").+?(?=\")/$version/gsm" pyproject.toml
 
 echo $"Test results:"
 python setup.py test
@@ -64,5 +65,5 @@ git push --tags
 
 rm -fr build dist
 python -m sphinx -M html ./docs ./build/sphinx
-python setup.py sdist bdist_wheel
+python -m pipx run build
 twine upload dist/*

pyproject.toml

@@ -1,6 +1,57 @@
-# We should probably migrate most of setup.cfg here
+[build-system]
+requires = ["setuptools", "setuptools-scm", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "geoip2"
+version = "4.7.0"
+description = "MaxMind GeoIP2 API"
+authors = [
+    {name = "Gregory Oschwald", email = "[email protected]"},
+]
+dependencies = [
+    "maxminddb",
+    "aiohttp>=3.6.2,<4.0.0",
+    "maxminddb>=2.3.0,<3.0.0",
+    "requests>=2.24.0,<3.0.0",
+    "setuptools>=60.0.0",
+]
+requires-python = ">=3.7"
+readme = "README.rst"
+license = {text = "Apache License, Version 2.0"}
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Internet",
+    "Topic :: Internet :: Proxy Servers",
+]
+
+[project.optional-dependencies]
+test = [
+    "mocket>=3.11.1",
+]
+
+[tool.setuptools.package-data]
+geoip2 = ["py.typed"]
+
+[project.urls]
+Homepage = "https://www.maxmind.com/"
+Documentation = "https://geoip2.readthedocs.org/"
+"Source Code" = "https://github.com/maxmind/GeoIP2-python"
+"Issue Tracker" = "https://github.com/maxmind/GeoIP2-python/issues"
 
 [tool.black]
 # src is showing up in our GitHub linting builds. It seems to
 # contain deps.
-extend-exclude = '^/src/'
+extend-exclude = '^/src/'

setup.cfg

@@ -1,44 +1,3 @@
-[metadata]
-name = geoip2
-author = Gregory Oschwald
-author_email = [email protected]
-license = Apache License, Version 2.0
-description = MaxMind GeoIP2 API
-url = https://www.maxmind.com/
-long_description = file: README.rst
-classifiers =
-    Development Status :: 5 - Production/Stable
-    Environment :: Web Environment
-    Intended Audience :: Developers
-    Intended Audience :: System Administrators
-    License :: OSI Approved :: Apache Software License
-    Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.7
-    Programming Language :: Python :: 3.8
-    Programming Language :: Python :: 3.9
-    Programming Language :: Python :: 3.10
-    Programming Language :: Python :: 3.11
-    Programming Language :: Python
-    Topic :: Internet :: Proxy Servers
-    Topic :: Internet
-project_urls =
-    Documentation = https://geoip2.readthedocs.org/
-    Source Code = https://github.com/maxmind/GeoIP2-python
-    Issue Tracker = https://github.com/maxmind/GeoIP2-python/issues
-
-[options]
-package_dir =
-    geoip2 = geoip2
-packages = geoip2
-install_requires =
-    aiohttp>=3.6.2,<4.0.0
-    maxminddb>=2.3.0,<3.0.0
-    requests>=2.24.0,<3.0.0
-include_package_data = True
-python_requires = >=3.7
-test_suite = tests
-tests_require = mocket>=3.11.1
-
 [flake8]
 # black uses 88 : ¯\_(ツ)_/¯
 max-line-length = 88