Run black .

Author: bobleesj

doc/source/conf.py

@@ -12,17 +12,18 @@
 #
 import sys
 import os
-sys.path.insert(0, os.path.abspath('../..'))
+
+sys.path.insert(0, os.path.abspath("../.."))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'snmf'
-copyright = '2009-2023, Trustees of Columbia University in the City of New York, all rights reserved.'
-author = 'Ran Gu, Adeolu Ajayi, Qiang Du,  Simon J.L. Billinge'
+project = "snmf"
+copyright = "2009-2023, Trustees of Columbia University in the City of New York, all rights reserved."
+author = "Ran Gu, Adeolu Ajayi, Qiang Du,  Simon J.L. Billinge"
 
 # The full version, including alpha/beta/rc tags
-release = '0.1.0'
+release = "0.1.0"
 
 
 # -- General configuration ---------------------------------------------------
@@ -31,65 +32,75 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 import sphinx_rtd_theme
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 
-	'sphinx.ext.todo', 'sphinx.ext.viewcode', 
-	'sphinx.ext.intersphinx', 'm2r']
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.intersphinx",
+    "m2r",
+]
 napoleon_google_docstring = False
 napoleon_use_param = False
 napoleon_use_ivar = False
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 from jinja2 import Template, Environment, FileSystemLoader
 
-source_suffix = '.rst'
+source_suffix = ".rst"
 
-master_doc = 'index'
+master_doc = "index"
 
-language = 'en'
+language = "en"
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['Thumbs.db', '.DS_Store'] 
+exclude_patterns = ["Thumbs.db", ".DS_Store"]
 
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 todo_include_todos = True
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 html_theme_options = {}
 
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
-htmlhelp_basename = 'snmfdoc'
+htmlhelp_basename = "snmfdoc"
 
 latex_documents = [
-	(master_doc, 'snmf.tex', 'Snmf Documentation',
-	'author', 'manual'),
+    (master_doc, "snmf.tex", "Snmf Documentation", "author", "manual"),
 ]
 
-man_pages = [
-	(master_doc, 'snmf', 'Snmf Documentation', [author], 1)
-]
+man_pages = [(master_doc, "snmf", "Snmf Documentation", [author], 1)]
 
 texinfo_documents = [
-	(master_doc, 'snmf', 'Snmf Documentation', author,
-	'snmf', 'One line description of project.', 'Miscellaneous'),
+    (
+        master_doc,
+        "snmf",
+        "Snmf Documentation",
+        author,
+        "snmf",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 epub_title = project
 epub_author = author
 epub_publisher = author
 epub_copyright = copyright
 
-epub_exclude_files = ['search.html']
+epub_exclude_files = ["search.html"]

run_tests.py

@@ -3,16 +3,15 @@
 import sys
 import pytest
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     # show output results from every test function
-    args = ['-v']
+    args = ["-v"]
     # show the message output for skipped and expected failure tests
     if len(sys.argv) > 1:
         args.extend(sys.argv[1:])
-    print('pytest arguments: {}'.format(args))
+    print("pytest arguments: {}".format(args))
     # # compute coverage stats for xpdAcq
     # call pytest and exit with the return code from pytest so that
     # travis will fail correctly if tests fail
     exit_res = pytest.main(args)
     sys.exit(exit_res)
-

setup.py

@@ -16,49 +16,49 @@
 # with open(os.path.join(MYDIR, 'requirements/run.txt')) as fp:
 #     requirements = [line.strip() for line in fp]
 
-with open(os.path.join(MYDIR, 'README.md')) as fp:
+with open(os.path.join(MYDIR, "README.md")) as fp:
     long_description = fp.read()
 
 
 # define distribution
 setup(
     name="diffpy.snmf",
-    version='0.0.1',
-    packages=find_packages(exclude=['tests', 'applications']),
+    version="0.0.1",
+    packages=find_packages(exclude=["tests", "applications"]),
     entry_points={
         # define console_scripts here, see setuptools docs for details.
-        'console_scripts': [
-            'snmf = diffpy.snmf.stretchednmfapp:main',
+        "console_scripts": [
+            "snmf = diffpy.snmf.stretchednmfapp:main",
         ],
     },
-    test_suite='tests',
+    test_suite="tests",
     # install_requires=requirements,
-    author='Ran Gu, Simon J.L. Billinge',
-    author_email='[email protected]',
-    maintainer='Simon J.L. Billinge',
-    maintainer_email='[email protected]',
-    url='https://github.com/diffpy/diffpy.snmf',
+    author="Ran Gu, Simon J.L. Billinge",
+    author_email="[email protected]",
+    maintainer="Simon J.L. Billinge",
+    maintainer_email="[email protected]",
+    url="https://github.com/diffpy/diffpy.snmf",
     description="A python package implementing the stretched NMF algorithm.",
-    long_description = long_description,
-    long_description_content_type = 'text/x-rst',
-    license='BSD',
+    long_description=long_description,
+    long_description_content_type="text/x-rst",
+    license="BSD",
     keywords="diffpy PDF",
-    classifiers = [
+    classifiers=[
         # List of possible values at
         # http://pypi.python.org/pypi?:action=list_classifiers
-        'Development Status :: 4 - Beta',
-        'Environment :: Console',
-        'Intended Audience :: Science/Research',
-        'License :: OSI Approved :: BSD License',
-        'Operating System :: MacOS :: MacOS X',
-        'Operating System :: Microsoft :: Windows',
-        'Operating System :: POSIX',
-        'Operating System :: Unix',
-        'Programming Language :: Python :: 3.9',
-        'Programming Language :: Python :: 3.10',
-        'Programming Language :: Python :: 3.11',
-        'Topic :: Scientific/Engineering :: Chemistry',
-        'Topic :: Scientific/Engineering :: Physics',
+        "Development Status :: 4 - Beta",
+        "Environment :: Console",
+        "Intended Audience :: Science/Research",
+        "License :: OSI Approved :: BSD License",
+        "Operating System :: MacOS :: MacOS X",
+        "Operating System :: Microsoft :: Windows",
+        "Operating System :: POSIX",
+        "Operating System :: Unix",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Topic :: Scientific/Engineering :: Chemistry",
+        "Topic :: Scientific/Engineering :: Physics",
     ],
 )