Addresses #28, #37 moved main files to src folder. Testing and sphinx…

.github/workflows/check.yml

@@ -18,9 +18,9 @@ jobs:
         with:
           python-version: 3.9
           cache: 'pip'
-          cache-dependency-path: '**/setup.py'
+          cache-dependency-path: '**/setup.cfg'
       - name: Install package with dependencies
         run: pip install -e ".[dev]"
         if: steps.python-cache.outputs.cache-hit != 'true'
       - name: Run black
-        run: black undate --check --diff
+        run: black src --check --diff

.github/workflows/unit_tests.yml

@@ -26,9 +26,9 @@ jobs:
         with:
           python-version: ${{ matrix.python }}
           cache: 'pip'
-          cache-dependency-path: '**/setup.py'
+          cache-dependency-path: '**/setup.cfg'
       - name: Install package with dependencies
         run: pip install -e ".[dev]"
         if: steps.python-cache.outputs.cache-hit != 'true'
       - name: Run unit tests
-        run: pytest
+        run: tox

.gitignore

@@ -26,10 +26,11 @@ wheels/
 MANIFEST
 
 # Environments
+.tox
 .env
 .venv
 env/
 venv/
 ENV/
 env.bak/
-venv.bak/
+venv.bak/

.readthedocs.yaml

@@ -0,0 +1,15 @@
+# File: .readthedocs.yaml
+
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.9"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt

Authors.rst

@@ -0,0 +1,4 @@
+AUTHORS
+=======
+
+DHtech Community

README.md

@@ -55,7 +55,12 @@ pre-commit install
 
 ### Run unit tests
 ```
-pytest
+tox
+```
+
+### Create documentation
+```
+tox -e docs
 ```
 
 ## Contributors

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/authors.rst

@@ -0,0 +1 @@
+.. include:: ../Authors.rst

docs/conf.py

@@ -0,0 +1,63 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# 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.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Undate'
+copyright = '2022, DHtech'
+author = 'DHtech Community'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.1.dev'
+
+master_doc = 'index'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'm2r2'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# 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 = ['_build', 'Thumbs.db', '.DS_Store']
+
+source_suffix = [".rst", ".md"]
+
+# -- 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'
+
+# 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_logo = '_static/logo.png'

docs/index.rst

@@ -0,0 +1,21 @@
+Undate documentation
+====================
+
+This project ...
+
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Contents:
+
+   readme
+   undate
+   authors
+   license
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/license.rst

@@ -0,0 +1,3 @@
+License
+=======
+.. mdinclude:: ../LICENSE.md

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/readme.rst

@@ -0,0 +1,3 @@
+Introduction
+============
+.. mdinclude:: ../README.md

docs/requirements.txt

@@ -0,0 +1,4 @@
+-e .[dev]
+sphinx
+sphinx_rtd_theme
+m2r2

docs/undate.rst

@@ -0,0 +1,11 @@
+Undate
+======
+
+.. autoclass:: undate.undate.Undate
+   :members:
+   :undoc-members:
+
+
+.. autoclass:: undate.undate.UndateInterval
+   :members:
+   :undoc-members:

pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"

setup.cfg

@@ -0,0 +1,46 @@
+[metadata]
+name = undate
+version = attr: undate.__version__
+author = 'DHTech'
+author_email = 'dhtech.community@gmail.com'
+description = "library for working with uncertain, fuzzy, or "
+    + "partially unknown dates and date intervals"
+long_description = file: README.md
+license="Apache License, Version 2.0",
+long_description_content_type = text/markdown
+url = https://github.com/dh-tech/hackathon-2022
+project_urls =
+    Project Home = https://dh-tech.github.io
+    Bug Tracker = https://github.com/dh-tech/hackathon-2022/-/issues
+classifiers =
+    Development Status :: 2 - Pre-Alpha
+    Programming Language :: Python :: 3
+    Intended Audience :: Developers
+    License :: OSI Approved :: Apache Software License
+    Operating System :: OS Independent
+    Topic :: Software Development :: Libraries :: Python Modules
+    Topic :: Utilities
+    Typing :: Typed
+
+[options]
+package_dir =
+    = src
+packages = find:
+python_requires = >=3.8
+install_requires =
+  python-dateutil
+[options.extras_require]
+all =
+  %(dev)s
+  %(test)s
+dev =
+  black>=22.10.0
+  pre-commit>=2.20.0
+  tox
+  sphinx
+  twine
+test = 
+  pytest>=7.2
+
+[options.packages.find]
+where = src

setup.py

@@ -1,50 +1,4 @@
-import os
-from setuptools import setup
+import setuptools
 
-from undate import __version__
-
-# load the readme contents and use for package long description
-with open(os.path.join(os.path.dirname(__file__), "README.md")) as readme:
-    README = readme.read()
-
-REQUIREMENTS = ["python-dateutil"]
-TEST_REQUIREMENTS = ["pytest>=7.2"]
-DEV_REQUIREMENTS = [
-    "black>=22.10.0",
-    "pre-commit>=2.20.0",
-]
-
-setup(
-    name="undate",
-    version=__version__,
-    description="library for working with uncertain, fuzzy, or "
-    + "partially unknown dates and date intervals",
-    long_description=README,
-    url="https://github.com/dh-tech/hackathon-2022",
-    author="DHTech",
-    author_email="dhtech.community@gmail.com",
-    license="Apache License, Version 2.0",
-    packages=["undate"],
-    install_requires=REQUIREMENTS,
-    tests_require=TEST_REQUIREMENTS,
-    extras_require={
-        "test": TEST_REQUIREMENTS,
-        "dev": TEST_REQUIREMENTS + DEV_REQUIREMENTS,
-    },
-    classifiers=[
-        # any relevant environment classifiers ?
-        "Development Status :: 2 - Pre-Alpha",
-        "Intended Audience :: Developers",
-        "License :: OSI Approved :: Apache Software License",
-        "Operating System :: OS Independent",
-        "Programming Language :: Python",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-        "Topic :: Software Development :: Libraries :: Python Modules",
-        "Topic :: Utilities",
-        "Typing :: Typed",
-    ],
-)
+if __name__ == "__main__":
+    setuptools.setup()

undate/undate.py → src/undate/undate.py

@@ -13,7 +13,7 @@
 ONE_DAY = datetime.timedelta(days=1)
 
 
-class Undate:
+class Undate():
     """Simple object for representing uncertain, fuzzy or partially unknown dates"""
 
     DEFAULT_FORMAT = "ISO8601"
@@ -88,7 +88,14 @@ def duration(self) -> datetime.timedelta:
         return self.latest - self.earliest + ONE_DAY
 
 
-class UndateInterval:
+class UndateInterval():
+    """A date range between two uncertain dates.
+
+    :param earliest: Earliest undate
+    :type earliest: `undate.Undate`
+    :param latest: Latest undate
+    :type latest:  `undate.Undate`
+    """
     # date range between two uncertain dates
 
     def __init__(
@@ -107,6 +114,11 @@ def __eq__(self, other) -> bool:
         return self.earliest == other.earliest and self.latest == other.latest
 
     def duration(self) -> datetime.timedelta:
+        """Calculate the duration between two undates.
+
+        :returns: A duration
+        :rtype: timedelta
+        """
         # what is the duration of this date range?
 
         # if both years are known, subtract end of range from beginning of start