Add first usable version

.gitignore

@@ -0,0 +1,6 @@
+__pycache__
+.coverage
+.idea/
+.DS_Store
+build/out/
+dist/

.travis.yml

@@ -0,0 +1,8 @@
+language: python
+python:
+  - "3.7"
+  - "3.8"
+  - "nightly"
+install: pip3 install coverage coveralls
+script: ./run-unittests.bash
+after_success: cd test && coveralls

README.rst

@@ -0,0 +1,32 @@
+|logo|
+
+Explicit is better than implicit
+================================
+
+|batch-unittest| |batch-doc| |batch-cov|
+
+dlb is a `Pythonic <https://www.python.org/dev/peps/pep-0020/>`_ build tool that does not try to mimic
+`Make <https://en.wikipedia.org/wiki/Make_%28software%29>`_, but brings the benefits of object-oriented languages
+to the build process.
+It is inspired by `djb's redo <https://cr.yp.to/redo.html>`_.
+
+dlb requires at least Python 3.7 (and nothing else).
+
+See here for more:
+
+  - https://dlb.readthedocs.io/
+  - https://pypi.python.org/pypi/dlb
+
+.. |logo| image:: ./doc/logo.png
+
+.. |batch-unittest| image:: https://travis-ci.org/dlu-ch/dlb.svg?branch=master
+   :alt: Build status (unittests)
+   :target: https://travis-ci.org/dlu-ch/dlb
+
+.. |batch-doc| image:: https://readthedocs.org/projects/dlb/badge/?version=latest
+   :alt: Documentation status (Sphinx)
+   :target: https://dlb.readthedocs.io/
+
+.. |batch-cov| image:: https://coveralls.io/repos/github/dlu-ch/dlb/badge.svg?branch=master
+   :alt: Test coverage status
+   :target: https://coveralls.io/github/dlu-ch/dlb?branch=master

build-doc.bash

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -e
+
+SPHINXBUILD=sphinx-build
+
+doc_dir=doc
+doc_to_root=..
+out_dir=build/out
+sphinx_out_dir="${out_dir:?}/sphinx"
+
+(
+    cd "./${doc_dir:?}"  # as readthedocs does it
+    rm -rf -- "./${doc_to_root:?}/${sphinx_out_dir:?}"
+    sphinx_args=("-d" "./${doc_to_root:?}/${sphinx_out_dir:?}/doctrees")
+    "${SPHINXBUILD:?}" "${sphinx_args[@]}" -b html . "./${doc_to_root:?}/${sphinx_out_dir:?}/html"
+    "${SPHINXBUILD:?}" "${sphinx_args[@]}" -b linkcheck  . "./${doc_to_root:?}/${sphinx_out_dir:?}/linkcheck"
+)

build-package.bash

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+set -e
+
+PYTHON=python3
+out_dir=build/out
+
+"${PYTHON:?}" setup.py build --build-base="${out_dir}/setupbuild" bdist_wheel --dist-dir=dist

build/version_from_repo.py

@@ -0,0 +1,45 @@
+import re
+import subprocess
+
+# each annotated tag starting with 'v' followed by a decimal digit must match this (after 'v'):
+VERSION_REGEX = re.compile(
+    r'^'
+    r'(?P<major>0|[1-9][0-9]*)\.(?P<minor>0|[1-9][0-9]*)\.(?P<micro>0|[1-9][0-9]*)'
+    r'((?P<post>[abc])(?P<post_number>0|[1-9][0-9]*))?'
+    r'$')
+
+
+def _version_from_describe(describe_word):
+    m = re.compile(r'v(?P<version>[0-9a-z.]+)-(?P<n>[0-9]+)-g(?P<hash>[0-9a-f]+)').fullmatch(describe_word)
+    if not m:
+        raise ValueError("git describe: {}".format(repr(describe_word)))
+
+    last_version = m.group('version')
+    commits_since_tag = int(m.group('n'), base=10)
+    commit_hash = m.group('hash')
+
+    m = VERSION_REGEX.fullmatch(last_version)
+    if not m:
+        raise ValueError(f'annotated tag is not a valid version tag: {last_version!r}')
+
+    gd = m.groupdict()
+    version_info = (int(gd['major']), int(gd['minor']), int(gd['micro']))
+    if gd['post']:
+        version_info = version_info + (gd['post'], int(gd['post_number']))
+
+    if commits_since_tag > 0:
+        # PEP 440
+        version = '{}.dev{}+{}'.format(last_version, commits_since_tag, commit_hash[:4])
+    else:
+        version = last_version
+
+    return version, version_info
+
+
+def get_version():
+    s = subprocess.check_output(['git', 'describe', '--match', 'v[0-9]*', '--long', '--abbrev=40']).decode()
+    return _version_from_describe(s.strip())
+
+
+assert _version_from_describe('v1.2.3-35-g13afa33') == ('1.2.3.dev35+13af', (1, 2, 3))
+assert _version_from_describe('v1.2.3a4-35-g13afa33') == ('1.2.3a4.dev35+13af', (1, 2, 3, 'a', 4))

doc/conf.py

@@ -0,0 +1,226 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Note: When readthedocs.org builds the documentation with the Sphinx, the the directory containing
+# this file is used as working directory.
+
+import sys
+import os.path
+root_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
+sys.path.insert(0, os.path.join(root_path, 'build'))
+sys.path.insert(0, os.path.join(root_path, 'src'))
+import version_from_repo
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# 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',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.graphviz',
+    'sphinx.ext.inheritance_diagram',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+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'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'dlb'
+copyright = '2016, Daniel Lutz'
+author = 'Daniel Lutz'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+
+# The full version, including alpha/beta/rc tags.
+release, _ = version_from_repo.get_version()
+
+# The short X.Y version.
+version = release
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#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
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#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 = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
+
+# -- 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 = 'bizstyle'
+
+# 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 = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+html_logo = 'logo.png'
+
+# 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
+
+# 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']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# 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'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+html_show_sourcelink = False
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'dlbdoc'
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'dlb', 'dlb Documentation',
+     [author], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+autodoc_member_order = 'bysource'
+graphviz_output_format = 'svg'
+graphviz_dot_args = [
+    '-Nfontname=Helvetica',
+    '-Nfontsize=10',
+    '-Nshape=box',
+    '-Nstyle="setlinewidth(0.5)"'
+    '-Earrowhead=empty',
+    '-Earrowsize=0.7',
+    '-Estyle="setlinewidth(0.5)"'
+]

doc/dlb.rst

@@ -0,0 +1,28 @@
+:mod:`dlb` --- Version
+======================
+
+.. module:: dlb
+   :synopsis: Version
+
+.. data:: __version__
+
+   The version of dlb as a non-empty string.
+   Example: ``'1.2.3``.
+
+   Conforms to :pep:`396`, :pep:`386` and :pep:`440`.
+
+   Contains the string ``'.dev'`` if and only if this a development version.
+   For a development version, *__version__* looks like this: ``'1.2.3.dev30+317f'``.
+
+.. data:: version_info
+
+   The version of dlb as a tuple of at least three members, similar to :data:`python:sys.version_info`.
+   Each member is a non-negative integer or a string ``'a'`` ... ``'z'``.
+   The first tree members are integers.
+   Example: ``(1, 2, 3, 'c', 4)``.
+
+   Use it like this to compare versions::
+
+      assert (1, 0) <= dlb.version_info  < (2,)
+
+   Note: For a development version, *version_info* carries less information than *__version__*.