diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..10e96fc3 --- /dev/null +++ b/LICENSE @@ -0,0 +1,28 @@ +BSD 3-Clause License + +Copyright (c) 2023, Astronomy Data Commons + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index f331d5d3..1fae89b4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -4,7 +4,7 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html -import os +from setuptools_scm import get_version # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information @@ -12,6 +12,9 @@ project = "LINCC Frameworks Python Project Template" copyright = "2023, LINCC Frameworks" author = "LINCC Frameworks" +release = get_version(root='..') +# for example take major/minor +version = ".".join(release.split(".")[:2]) # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 00000000..e96a679d --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,28 @@ +[project] +name = "python-project-template" +license = {file = "LICENSE"} +readme = "README.md" +authors = [ + { name = "LINCC Frameworks", email = "lincc-frameworks-team@lists.lsst.org" } +] +classifiers = [ + "Development Status :: 4 - Beta", + "Intended Audience :: Developers", + "Intended Audience :: Science/Research", + "Operating System :: OS Independent", + "Programming Language :: Python", +] +dynamic = ["version"] + +dependencies = [ + "setuptools_scm", + "sphinx==6.1.3", # Used to automatically generate documentation + "sphinx_rtd_theme==1.2.0", # Used to render documentation +] + +[build-system] +requires = [ + "setuptools>=45", # Used to build and package the Python project + "setuptools_scm>=6.2", # Gets release version from git. Makes it available programmatically +] +build-backend = "setuptools.build_meta" \ No newline at end of file