From e58217e5f500c3775a932428c5ad4d7174224dfc Mon Sep 17 00:00:00 2001 From: Zach Burnett Date: Wed, 26 Oct 2022 11:59:52 -0400 Subject: [PATCH 1/8] move build configuration to `pyproject.toml` --- docs/source/conf.py | 88 ++++++++++++++++++++++++--------------------- pyproject.toml | 53 +++++++++++++++++++++++++-- setup.py | 45 +++++------------------ 3 files changed, 106 insertions(+), 80 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 6d2b1fc..242a956 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -10,16 +10,21 @@ # # All configuration values have a default; values that are commented out # serve to show the default. +from datetime import datetime +from pathlib import Path -import sys, os +import tomli as tomli from stsci.sphinxext.conf import * # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.append(os.path.abspath('.')) +# sys.path.append(os.path.abspath('.')) # -- General configuration ----------------------------------------------------- +with open(Path(__file__).parent.parent.parent / "pyproject.toml", "rb") as configuration_file: + conf = tomli.load(configuration_file) +setup_cfg = conf['project'] # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. @@ -33,14 +38,16 @@ source_suffix = '.rst' # The encoding of source files. -#source_encoding = 'utf-8' +# source_encoding = 'utf-8' # The master toctree document. master_doc = 'index' # General information about the project. -project = u'image' -copyright = u'2012, STScI' +project = setup_cfg['name'] +primary_author = setup_cfg["authors"][0] +author = f'{primary_author["name"]} <{primary_author["email"]}>' +copyright = f'{datetime.now().year}, {primary_author["name"]}' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -53,71 +60,71 @@ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of documents that shouldn't be included in the build. -#unused_docs = [] +# unused_docs = [] # List of directories, relative to source directory, that shouldn't be searched # for source files. exclude_trees = [] # The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. -#html_theme = 'default' +# html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -126,74 +133,73 @@ # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_use_modindex = True +# html_use_modindex = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' +# html_file_suffix = '' # Output file base name for HTML help builder. htmlhelp_basename = 'imagedoc' - # -- Options for LaTeX output -------------------------------------------------- # The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' +# latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' +# latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'image.tex', u'Image Documentation', - u'STScI', 'manual'), + ('index', 'image.tex', u'Image Documentation', + u'STScI', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # Additional stuff for the LaTeX preamble. -#latex_preamble = '' +# latex_preamble = '' # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_use_modindex = True +# latex_use_modindex = True # Example configuration for intersphinx: refer to the Python standard library. diff --git a/pyproject.toml b/pyproject.toml index 3f1ce5a..df0c06a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,10 +1,57 @@ +[project] +name = 'stsci.image' +description = 'Image array manipulation functions' +readme = 'README.md' +requires-python = '>=3.6' +license = { file = 'LICENSE' } +authors = [{ name = 'STScI', email = 'help@stsci.edu' }] +classifiers = [ + 'Intended Audience :: Science/Research', + 'License :: OSI Approved :: BSD License', + 'Operating System :: OS Independent', + 'Programming Language :: Python', + 'Topic :: Scientific/Engineering :: Astronomy', + 'Topic :: Software Development :: Libraries :: Python Modules', +] +dependencies = [ + 'numpy>=1.14', + 'scipy', +] +dynamic = ['version'] + +[project.optional-dependencies] +test = [ + 'pytest', +] +docs = [ + 'numpydoc', + 'sphinx', + 'sphinx-automodapi', + 'sphinx-rtd-theme', + 'stsci-rtd-theme', + 'tomli; python_version <"3.11"', +] + +[project.urls] +'repository' = 'https://github.com/spacetelescope/stsci.image' + [build-system] requires = [ - "setuptools>=42", - "setuptools_scm", + "setuptools >=61", + "setuptools_scm[toml] >=3.4", "wheel", "oldest-supported-numpy; python_version>='3.7'", - ] + "numpy==1.14.6; python_version<'3.7'", +] build-backend = "setuptools.build_meta" [tool.setuptools_scm] + +[tool.setuptools] +zip-safe = false + +[tool.setuptools.packages.find] +include = ['stsci'] + +[tool.setuptools.package-data] +'*' = ['LICENSE.txt'] diff --git a/setup.py b/setup.py index 094deb3..b8241cf 100755 --- a/setup.py +++ b/setup.py @@ -1,40 +1,13 @@ -from setuptools import setup, find_packages, Extension from numpy import get_include as np_include +from setuptools import setup, Extension + +ext_modules = [ + Extension('stsci.image._combine', + ['src/_combinemodule.c'], + include_dirs=[np_include()], + define_macros=[('NUMPY', '1')]), +] setup( - name='stsci.image', - author='STScI', - author_email='help@stsci.edu', - description='Image array manipulation functions', - url='https://github.com/spacetelescope/stsci.image', - classifiers=[ - 'Intended Audience :: Science/Research', - 'License :: OSI Approved :: BSD License', - 'Operating System :: OS Independent', - 'Programming Language :: Python', - 'Topic :: Scientific/Engineering :: Astronomy', - 'Topic :: Software Development :: Libraries :: Python Modules', - ], - install_requires=[ - 'numpy>=1.14', - 'scipy', - ], - python_requires='>=3.7', - packages=find_packages(), - package_data={ - '': ['LICENSE.txt'], - }, - ext_modules=[ - Extension('stsci.image._combine', - ['src/_combinemodule.c'], - include_dirs=[np_include()], - define_macros=[('NUMPY', '1')]), - ], - use_scm_version=True, - setup_requires=['setuptools_scm'], - extras_require={ - "test": [ - "pytest" - ] - } + ext_modules=ext_modules, ) From ba3e848033087b7761c0cef5da404a77eac945a6 Mon Sep 17 00:00:00 2001 From: Zach Burnett Date: Mon, 23 Jan 2023 08:35:40 -0500 Subject: [PATCH 2/8] read toml --- docs/source/conf.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 242a956..7cb77e9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -13,7 +13,7 @@ from datetime import datetime from pathlib import Path -import tomli as tomli +import tomli from stsci.sphinxext.conf import * # If extensions (or modules to document with autodoc) are in another directory, @@ -44,10 +44,11 @@ master_doc = 'index' # General information about the project. -project = setup_cfg['name'] -primary_author = setup_cfg["authors"][0] -author = f'{primary_author["name"]} <{primary_author["email"]}>' -copyright = f'{datetime.now().year}, {primary_author["name"]}' +with open(Path(__file__).parent.parent.parent / "pyproject.toml", "rb") as metadata_file: + metadata = tomli.load(metadata_file)['project'] +project = metadata['name'] +author = f'{metadata["authors"][0]["name"]} <{metadata["authors"][0]["email"]}>' +copyright = f'{datetime.today().year}, {author}' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the From 17082afb62b8282cf5c523d6eb5c68fc836ac0ee Mon Sep 17 00:00:00 2001 From: Zach Burnett Date: Wed, 19 Apr 2023 11:38:56 -0400 Subject: [PATCH 3/8] use `tomllib` in Python `>= 3.11` --- docs/source/conf.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 7cb77e9..71e7c04 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -13,7 +13,10 @@ from datetime import datetime from pathlib import Path -import tomli +if sys.version_info < (3, 11): + import tomli as tomllib + else: + import tomllib from stsci.sphinxext.conf import * # If extensions (or modules to document with autodoc) are in another directory, @@ -23,7 +26,7 @@ # -- General configuration ----------------------------------------------------- with open(Path(__file__).parent.parent.parent / "pyproject.toml", "rb") as configuration_file: - conf = tomli.load(configuration_file) + conf = tomllib.load(configuration_file) setup_cfg = conf['project'] # Add any Sphinx extension module names here, as strings. They can be extensions From bbdac585d7f57a187078a23a8e8bb152a1943751 Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Thu, 7 Dec 2023 11:51:53 -0500 Subject: [PATCH 4/8] formatting --- pyproject.toml | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index df0c06a..db65020 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,21 +1,21 @@ [project] -name = 'stsci.image' -description = 'Image array manipulation functions' -readme = 'README.md' -requires-python = '>=3.6' -license = { file = 'LICENSE' } -authors = [{ name = 'STScI', email = 'help@stsci.edu' }] +name = "stsci.image" +description = "Image array manipulation functions" +readme = "README.md" +requires-python = ">=3.6" +license = { file = "LICENSE" } +authors = [{ name = "STScI", email = "help@stsci.edu" }] classifiers = [ - 'Intended Audience :: Science/Research', - 'License :: OSI Approved :: BSD License', - 'Operating System :: OS Independent', - 'Programming Language :: Python', - 'Topic :: Scientific/Engineering :: Astronomy', - 'Topic :: Software Development :: Libraries :: Python Modules', + "Intended Audience :: Science/Research", + "License :: OSI Approved :: BSD License", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Topic :: Scientific/Engineering :: Astronomy", + "Topic :: Software Development :: Libraries :: Python Modules", ] dependencies = [ - 'numpy>=1.14', - 'scipy', + "numpy>=1.14", + "scipy", ] dynamic = ['version'] @@ -37,16 +37,14 @@ docs = [ [build-system] requires = [ - "setuptools >=61", - "setuptools_scm[toml] >=3.4", + "setuptools >=61.2", + "setuptools_scm[toml] >=6.2", "wheel", "oldest-supported-numpy; python_version>='3.7'", "numpy==1.14.6; python_version<'3.7'", ] build-backend = "setuptools.build_meta" -[tool.setuptools_scm] - [tool.setuptools] zip-safe = false @@ -54,4 +52,6 @@ zip-safe = false include = ['stsci'] [tool.setuptools.package-data] -'*' = ['LICENSE.txt'] +"*" = ["LICENSE.txt"] + +[tool.setuptools_scm] From e37fe0f45232d6e12c042eafe9a1db199d57ed10 Mon Sep 17 00:00:00 2001 From: Zach Burnett Date: Thu, 7 Dec 2023 13:20:44 -0500 Subject: [PATCH 5/8] Apply suggestions from code review Co-authored-by: Nadia Dencheva --- pyproject.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index db65020..1ef27db 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,7 +2,7 @@ name = "stsci.image" description = "Image array manipulation functions" readme = "README.md" -requires-python = ">=3.6" +requires-python = ">=3.9" license = { file = "LICENSE" } authors = [{ name = "STScI", email = "help@stsci.edu" }] classifiers = [ @@ -14,7 +14,7 @@ classifiers = [ "Topic :: Software Development :: Libraries :: Python Modules", ] dependencies = [ - "numpy>=1.14", + "numpy", "scipy", ] dynamic = ['version'] From 599e49e1ae6940823b10dc670a00c6c025222a31 Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Thu, 7 Dec 2023 13:24:53 -0500 Subject: [PATCH 6/8] remove older numpy versions --- pyproject.toml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 1ef27db..11b16ea 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -40,8 +40,7 @@ requires = [ "setuptools >=61.2", "setuptools_scm[toml] >=6.2", "wheel", - "oldest-supported-numpy; python_version>='3.7'", - "numpy==1.14.6; python_version<'3.7'", + "oldest-supported-numpy", ] build-backend = "setuptools.build_meta" From 157ab759a0731fc78b9be28ab9a69bc43598afcc Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Fri, 8 Dec 2023 11:09:34 -0500 Subject: [PATCH 7/8] remove Python 3.8 job --- .github/workflows/ci.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c4e5428..5fe4a22 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -20,8 +20,6 @@ jobs: fail-fast: false matrix: include: - - python-version: "3.8" - numpy-version: "~=1.19.0" - python-version: "3.12" numpy-version: "~=1.26.0" python-version: ["3.9", "3.10", "3.11"] From edcd9248b7b634b6ed678e817cfbfd894c6c9ec5 Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Wed, 1 May 2024 09:34:29 -0400 Subject: [PATCH 8/8] fix duplicate metadata read --- docs/source/conf.py | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 71e7c04..adfaeb6 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -25,9 +25,8 @@ # sys.path.append(os.path.abspath('.')) # -- General configuration ----------------------------------------------------- -with open(Path(__file__).parent.parent.parent / "pyproject.toml", "rb") as configuration_file: - conf = tomllib.load(configuration_file) -setup_cfg = conf['project'] +with open(Path(__file__).parent.parent.parent / "pyproject.toml", "rb") as metadata_file: + metadata = tomli.load(metadata_file)['project'] # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. @@ -47,8 +46,6 @@ master_doc = 'index' # General information about the project. -with open(Path(__file__).parent.parent.parent / "pyproject.toml", "rb") as metadata_file: - metadata = tomli.load(metadata_file)['project'] project = metadata['name'] author = f'{metadata["authors"][0]["name"]} <{metadata["authors"][0]["email"]}>' copyright = f'{datetime.today().year}, {author}'