Package.json single source of version

Author: stuartquin

docs/source/conf.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
+
 # jupyterannotate documentation build configuration file
 #
 # This file is execfile()d with the current directory set to its
@@ -23,14 +24,14 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.todo',
-    'nbsphinx',
-    'jupyter_sphinx',
-    'nbsphinx_link',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
+    "nbsphinx",
+    "jupyter_sphinx",
+    "nbsphinx_link",
 ]
 
 # Set the nbsphinx JS path to empty to avoid showing twice of the widgets
@@ -40,27 +41,28 @@
 # Ensure our extension is available:
 import sys
 from os.path import dirname, join as pjoin
+
 docs = dirname(dirname(__file__))
 root = dirname(docs)
 sys.path.insert(0, root)
-sys.path.insert(0, pjoin(docs, 'sphinxext'))
+sys.path.insert(0, pjoin(docs, "sphinxext"))
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'jupyterannotate'
-copyright = '2022, Stuart Quin'
-author = 'Stuart Quin'
+project = "jupyterannotate"
+copyright = "2022, Stuart Quin"
+author = "Stuart Quin"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -71,17 +73,18 @@
 
 # get version from python package:
 import os
+
 here = os.path.dirname(__file__)
-repo = os.path.join(here, '..', '..')
-_version_py = os.path.join(repo, 'jupyterannotate', '_version.py')
+repo = os.path.join(here, "..", "..")
+_version_py = os.path.join(repo, "jupyterannotate", "_version.py")
 version_ns = {}
 with open(_version_py) as f:
     exec(f.read(), version_ns)
 
 # The short X.Y version.
-version = '%i.%i' % version_ns['version_info'][:2]
+version = "%s.%s" % version_ns["version_info"][:2]
 # The full version, including alpha/beta/rc tags.
-release = version_ns['__version__']
+release = version_ns["__version__"]
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -93,10 +96,10 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['**.ipynb_checkpoints']
+exclude_patterns = ["**.ipynb_checkpoints"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -114,13 +117,13 @@
 # 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"]
 
 
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'jupyterannotatedoc'
+htmlhelp_basename = "jupyterannotatedoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -129,15 +132,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -147,8 +147,13 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'jupyterannotate.tex', 'jupyterannotate Documentation',
-     'Stuart Quin', 'manual'),
+    (
+        master_doc,
+        "jupyterannotate.tex",
+        "jupyterannotate Documentation",
+        "Stuart Quin",
+        "manual",
+    ),
 ]
 
 
@@ -157,10 +162,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc,
-    'jupyterannotate',
-    'jupyterannotate Documentation',
-     [author], 1)
+    (master_doc, "jupyterannotate", "jupyterannotate Documentation", [author], 1)
 ]
 
 
@@ -170,27 +172,30 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc,
-     'jupyterannotate',
-     'jupyterannotate Documentation',
-     author,
-     'jupyterannotate',
-     'A Custom Jupyter Widget Library',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "jupyterannotate",
+        "jupyterannotate Documentation",
+        author,
+        "jupyterannotate",
+        "A Custom Jupyter Widget Library",
+        "Miscellaneous",
+    ),
 ]
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {"https://docs.python.org/": None}
 
 # Read The Docs
 # on_rtd is whether we are on readthedocs.org, this line of code grabbed from
 # docs.readthedocs.org
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
 if not on_rtd:  # only import and set the theme if we're building docs locally
     import sphinx_rtd_theme
-    html_theme = 'sphinx_rtd_theme'
+
+    html_theme = "sphinx_rtd_theme"
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # otherwise, readthedocs.org uses their theme by default, so no need to specify it
@@ -199,15 +204,18 @@
 # Uncomment this line if you have know exceptions in your included notebooks
 # that nbsphinx complains about:
 #
-nbsphinx_allow_errors = True # exception ipstruct.py ipython_genutils
+nbsphinx_allow_errors = True  # exception ipstruct.py ipython_genutils
 
 from sphinx.util import logging
+
 logger = logging.getLogger(__name__)
 
+
 def setup(app):
     def add_scripts(app):
-        for fname in ['helper.js', 'embed-bundle.js']:
-            if not os.path.exists(os.path.join(here, '_static', fname)):
-                logger.warning('missing javascript file: %s' % fname)
+        for fname in ["helper.js", "embed-bundle.js"]:
+            if not os.path.exists(os.path.join(here, "_static", fname)):
+                logger.warning("missing javascript file: %s" % fname)
             app.add_js_file(fname)
-    app.connect('builder-inited', add_scripts)
+
+    app.connect("builder-inited", add_scripts)

jupyterannotate/_version.py

@@ -4,5 +4,16 @@
 # Copyright (c) Stuart Quin.
 # Distributed under the terms of the Modified BSD License.
 
-version_info = (0, 1, 2)
-__version__ = ".".join(map(str, version_info))
+import json
+from os.path import exists
+
+if exists("./package.json"):
+    package_json = None
+    with open("./package.json", "r") as package_json_file:
+        package_json = json.loads(package_json_file.read())
+
+    __version__ = package_json["version"]
+else:
+    __version__ = "0.0.0"
+
+version_info = tuple(__version__.split("."))