Skip to content

Commit

Permalink
Upgrade packaging to PEP 517 & setup.cfg and update metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
CAM-Gerlach committed Dec 16, 2021
1 parent a5dbb78 commit 029dc91
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 35 deletions.
2 changes: 1 addition & 1 deletion docrepr/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
Derived from spyderlib.utils.inspector and IPython.core.oinspect
"""

from ._version import version_info, __version__
__version__ = '0.2.0.dev0'

# Configuration options for docrepr
options = {
Expand Down
2 changes: 0 additions & 2 deletions docrepr/_version.py

This file was deleted.

6 changes: 6 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[build-system]
requires = [
"setuptools>=42",
"wheel",
]
build-backend = "setuptools.build_meta"
63 changes: 63 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
[metadata]
name = docrepr
version = attr: docrepr.__version__
description = Renders Python docstrings to rich HTML
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/spyder-ide/docrepr
author = Tim Dumol and the Spyder Development Team
author_email = [email protected]
maintainer = Spyder Development Team and Docrepr Contributors
maintainer_email = [email protected]
license = BSD-3-clause
license_file = LICENSE.txt
license_files =
AUTHORS.md
LICENSE.txt
classifiers =
Development Status :: 4 - Beta
Environment :: Web Environment
Framework :: IPython
Framework :: Jupyter
Framework :: Matplotlib
Framework :: Sphinx
Intended Audience :: Developers
Intended Audience :: Science/Research
License :: OSI Approved :: BSD License
Operating System :: OS Independent
Programming Language :: Python :: 3
Programming Language :: Python :: 3 :: Only
Programming Language :: Python :: 3.6
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9
Topic :: Documentation :: Sphinx
Topic :: Scientific/Engineering :: Visualization
Topic :: Software Development :: Documentation
Topic :: Software Development :: Libraries :: Python Modules
Topic :: Text Processing :: Markup :: reStructuredText
Topic :: Utilities
keywords = Sphinx docstrings renderer HTML Spyder IPython help formatter
project_urls =
Github = https://github.com/spyder-ide/docrepr
Bug Tracker = https://github.com/spyder-ide/docrepr/issues
Parent Project = https://www.spyder-ide.org/

[options]
packages = find:
install_requires =
docutils
jinja2
sphinx>=1.1
python_requires = >=3.6
include_package_data = True
zip_safe = False

[options.extras_require]
plot =
matplotlib>=2.2.4
test =
ipython
matplotlib>=2.2.4
numpy
pytest>=6.0.0
37 changes: 5 additions & 32 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,35 +1,8 @@
from setuptools import setup, find_packages
import os
#!/usr/bin/env python3

name = 'docrepr'
here = os.path.abspath(os.path.dirname(__file__))
"""Stub setup.py for use with legacy build tooling."""

version_ns = {}
with open(os.path.join(here, name, '_version.py')) as f:
exec(f.read(), {}, version_ns)
import setuptools

setup(
name=name,
version=version_ns['__version__'],
description='docrepr renders Python docstrings in HTML',
long_description='docrepr renders Python docstrings in HTML. It is based on the sphinxify module developed by Tim Dumol for the Sage Notebook and the utils.inspector developed for ther Spyder IDE.',
packages=find_packages(),
include_package_data=True,
python_requires='>=3.6',
install_requires=['docutils', 'jinja2', 'sphinx>=1.1'],
extras_require={
'plot': [
'matplotlib>=2.2.4',
],
'test': [
'ipython',
'matplotlib>=2.2.4',
'numpy',
'pytest>=6',
],
},
url='https://github.com/spyder-ide/docrepr',
author='Tim Dumol / The Spyder Development Team',
maintainer='The Spyder Development Team',
license='BSD',
)
if __name__ == "__main__":
setuptools.setup()

0 comments on commit 029dc91

Please sign in to comment.