Skip to content
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.

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

migrate to setup.cfg #1162

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,6 @@ jobs:
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
run: |
python setup.py publish
python -m build
twine check dist/*
twine upload dist/*
67 changes: 67 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
[build-system]
requires = ["setuptools>=61.2"]
build-backend = "setuptools.build_meta"

[project]
name = "drf-spectacular"
authors = [{name = "T. Franzel", email = "[email protected]"}]
license = {text = "BSD"}
description = "Sane and flexible OpenAPI 3 schema generation for Django REST framework"
classifiers = [
"Development Status :: 5 - Production/Stable",
"Environment :: Web Environment",
"Framework :: Django",
"Framework :: Django :: 2.2",
"Framework :: Django :: 3.2",
"Framework :: Django :: 4.0",
"Framework :: Django :: 4.1",
"Framework :: Django :: 4.2",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
"Natural Language :: English",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"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 :: WWW/HTTP",
"Topic :: Documentation",
"Topic :: Software Development :: Code Generators",
]
requires-python = ">=3.6"
dependencies = [
"Django>=2.2",
"djangorestframework>=3.10.3",
"uritemplate>=2.0.0",
"PyYAML>=5.1",
"jsonschema>=2.6.0",
"inflection>=0.3.1",
'typing-extensions; python_version < "3.10"',
]
dynamic = ["version"]

[project.readme]
file = "README.rst"
content-type = "text/x-rst"

[project.urls]
Homepage = "https://github.com/tfranzel/drf-spectacular"
Source = "https://github.com/tfranzel/drf-spectacular"
Documentation = "https://drf-spectacular.readthedocs.io"

[project.optional-dependencies]
offline = ["drf-spectacular-sidecar"]
sidecar = ["drf-spectacular-sidecar"]

[tool.setuptools]
include-package-data = true

[tool.setuptools.packages]
find = {namespaces = false}

[tool.setuptools.dynamic]
version = {attr = "drf_spectacular.__version__"}
1 change: 1 addition & 0 deletions requirements/packaging.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
twine>=3.1.1
wheel>=0.34.2
build
setuptools
110 changes: 2 additions & 108 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,109 +1,3 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
import os
import re
import shutil
import sys
from setuptools import setup

from setuptools import find_namespace_packages, setup

name = 'drf-spectacular'
package = 'drf_spectacular'
description = 'Sane and flexible OpenAPI 3 schema generation for Django REST framework'
url = 'https://github.com/tfranzel/drf-spectacular'
author = 'T. Franzel'
author_email = '[email protected]'
license = 'BSD'

with open('README.rst') as readme:
long_description = readme.read()

with open('requirements/base.txt') as fh:
requirements = [r for r in fh.read().split('\n') if not r.startswith('#')]


def get_version(package):
"""
Return package version as listed in `__version__` in `init.py`.
"""
init_py = open(os.path.join(package, '__init__.py')).read()
return re.search("^__version__ = ['\"]([^'\"]+)['\"]",
init_py, re.MULTILINE).group(1)


version = get_version(package)


if sys.argv[-1] == 'publish':
if os.system("pip freeze | grep twine"):
print("twine not installed.\nUse `pip install twine`.\nExiting.")
sys.exit(1)
os.system("python setup.py sdist bdist_wheel")
if os.system("twine check dist/*"):
print("twine check failed. Packages might be outdated.")
print("Try using `pip install -U twine wheel`.\nExiting.")
sys.exit(1)
if os.system("twine upload dist/*"):
print("failed to upload package")
sys.exit(1)
if os.environ.get('CI'):
os.system("git config user.name github-actions")
os.system("git config user.email [email protected]")
os.system(f"git tag -a {version} -m 'version {version}'")
if os.system("git push --tags"):
print("failed pushing release tag")
sys.exit(1)
shutil.rmtree('dist')
shutil.rmtree('build')
shutil.rmtree('drf_spectacular.egg-info')
sys.exit()


setup(
name=name,
version=version,
url=url,
license=license,
description=description,
long_description=long_description,
long_description_content_type='text/x-rst',
author=author,
author_email=author_email,
packages=[p for p in find_namespace_packages(exclude=('tests*',)) if p.startswith(package)],
include_package_data=True,
python_requires=">=3.6",
install_requires=requirements,
extras_require={
"offline": ["drf-spectacular-sidecar"],
"sidecar": ["drf-spectacular-sidecar"],
},
classifiers=[
'Development Status :: 5 - Production/Stable',
'Environment :: Web Environment',
'Framework :: Django',
'Framework :: Django :: 2.2',
'Framework :: Django :: 3.2',
'Framework :: Django :: 4.0',
'Framework :: Django :: 4.1',
'Framework :: Django :: 4.2',
'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
'Operating System :: OS Independent',
'Natural Language :: English',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.6',
'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 :: WWW/HTTP',
'Topic :: Documentation',
'Topic :: Software Development :: Code Generators',
],
project_urls={
'Source': 'https://github.com/tfranzel/drf-spectacular',
'Documentation': 'https://drf-spectacular.readthedocs.io',
},
)
setup()