dk-tasklib 3.0.9__py3-none-any.whl

dk_tasklib-3.0.9.dist-info/METADATA

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: dk-tasklib
+Version: 3.0.9
+Summary: dk-tasklib - pyinvoke task library
+Home-page: https://github.com/datakortet/dk-tasklib
+Author: Bjorn Pettersen
+Author-email: bp@datakortet.no
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Requires-Dist: invoke
+Requires-Dist: PyYAML
+Requires-Dist: dkfileutils>=1.4.2
+Requires-Dist: yamldirs>=1.1.8
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: summary
+
+
+.. image:: https://travis-ci.org/datakortet/dk-tasklib.svg?branch=master
+   :target: https://travis-ci.org/datakortet/dk-tasklib
+
+.. image:: https://coveralls.io/repos/github/datakortet/dk-tasklib/badge.svg?branch=master
+   :target: https://coveralls.io/github/datakortet/dk-tasklib?branch=master
+
+dk-tasklib - pyinvoke task library
+====================================
+
+
+Installing from PyPI
+--------------------
+
+This is what you want if you just want to use dk-tasklib:
+
+   pip install dk-tasklib
+
+
+Creating a default tasks.py file
+--------------------------------
+You can create a default ``tasks.py`` file. From the root of your package::
+
+    dk-tasklib install
+
+You'll need to specify ``--force`` to overwrite an existing file.
+
+As a source package
+-------------------
+This is what you want if you are developing dk-tasklib or want 
+to make local changes to the source code.
+
+   pip install -e <path>
+
+
+See docs/ folder for documentation.
+
+
+Development
+-----------
+
+Run the authoritative package checks from the repository root::
+
+    dk testpackage
+
+The suite enforces branch-aware coverage of at least 83 percent. Build the
+documentation with::
+
+    dk docs
+
+The documentation is maintained against current Sphinx 8 and 9 releases.

dk_tasklib-3.0.9.dist-info/RECORD

@@ -0,0 +1,35 @@
+dktasklib/__init__.py,sha256=XEy0mO984KPXEXIbohLYDjl_7UeV2tiuM58BVfyIKlQ,129
+dktasklib/_version.py,sha256=GgzlXELdHTkTAUXqLnCAGFr2E0nwjjBPe-3RxfSkl6c,22
+dktasklib/clean.py,sha256=m4IF-XI6J5KJz7WvWDYoA7Sr65OI7K3GR9IcJsKAQ2Y,212
+dktasklib/commands.py,sha256=bh8aF8RYBfCgOwhWmGsRpGeyeZl5EXbOHUL11OOTNc4,3165
+dktasklib/concat.py,sha256=GfAqc94dS8Lki25RIMaCx4_A8iVsKN6mTJjQZwW-rk4,1942
+dktasklib/docs.py,sha256=1iIOUE4mKTksTbRLcDZ2vNz3PltgdNlbANii2_iGRKc,6463
+dktasklib/environment.py,sha256=3eX8e-z4C94tcim6vw5mWOiD6952PWG0EaW1-bWin40,113
+dktasklib/executables.py,sha256=1puqMZ1ni87V0a0sQsF5iGNvXtmaF7MCD25Gst9P6no,6621
+dktasklib/help.py,sha256=FNKuVusc-Dev8ihEk98mmxY9WNUEwi-6F7IikHW6EQo,359
+dktasklib/jstools.py,sha256=W4kBh7xPJsiZb2U4r2HPrKCufsx9Zya7lyXA3PIg_OQ,10535
+dktasklib/lessc.py,sha256=Gx0jUHz02QXnxevQGDSdy045VpLSA2PGNITa6LJqzRo,3375
+dktasklib/manage.py,sha256=0S1PAjAfJctjT6RCNLw4pvBst83rP_TaeUk-QLXP4VU,2631
+dktasklib/npm.py,sha256=6W2AmYptF6sWNAdrgefDGHDcYAUDBVF1pIprLNDyb4Q,518
+dktasklib/pset.py,sha256=L656kmzR4OXIsHni2OPQAVm6ctw-O0_YScOnZCVYV-s,3304
+dktasklib/publish.py,sha256=j8rZ2VXnDd4ak3GXvmy4zDpDnzsRqbJAgB7dvKijyec,1361
+dktasklib/rule.py,sha256=6D85tS3tIgiK9ll_0leaGH-rUsFqTA0oZqqW8W-Dg8o,1572
+dktasklib/runners.py,sha256=OvGY-3ljyX-SYxf7rib9CWMLa0Whaoxvgc_tyfO2URw,990
+dktasklib/upversion.py,sha256=CppaS2nIx9KhjB-wb03LWIkNfzkFdm7xNhLYBa2w6aI,5166
+dktasklib/urlinliner.py,sha256=vSBUOVD9mqfSJkMCiPYjWwU62RVtG346rIkJKc6qMi4,2505
+dktasklib/utils.py,sha256=tqP0VCYi4ulP63deJhsg3XO3e7FEl0cMzkXj2LKPb4s,6845
+dktasklib/version.py,sha256=QbZ6_WbnWwX1okaf0hkPRoQLv9Bmyn_GB_rzwDsk0rI,2599
+dktasklib/watch.py,sha256=qm4oE-8y8GNg7esYyc90O9u9Koug2LwvxxSrUkTUcVM,2416
+dktasklib/wintask.py,sha256=gb7JnDmiV9O-nDOTUq_Kci02_PR3v5J4GpK7M6ffR3M,45
+dktasklib/entry_points/__init__.py,sha256=1vjEu0jaBda00GRE2eJrronfxy0TaCSUTe4jUikzw1U,45
+dktasklib/entry_points/confbase.py,sha256=3GFatqsGxo0c4DZYgWLgJdWri7AVspqSS96PhWOLeSo,5352
+dktasklib/entry_points/dktasklibcmd.py,sha256=fTulpX9lQa7H_iUNNuJxMCeHTRfF7V2Ylgv-oTEVFNo,2824
+dktasklib/entry_points/pytemplate.py,sha256=po3Xybr9xuRM4BABVwBgyyd525jJNUU6Q8clp5wPcnQ,431
+dktasklib/entry_points/taskbase.py,sha256=LquiNxt5kYVztBG8xBtrTwRfF7DtDhTBiY2j8GiyjfM,4021
+dktasklib/package/__init__.py,sha256=K_ojfTu6ebW0ETjXUrUZTrluJS0OWcjigdNAATd6ga4,1138
+dktasklib/package/package_interface.py,sha256=vICO-4Y0Zjuwyba_ERlZoexFT9TlZH0bhsn_qFKz2cw,3068
+dk_tasklib-3.0.9.dist-info/METADATA,sha256=HtrAsqA0B-X4gYuLBzf-YIdkjoY9dv3KK22XY3giFZM,2087
+dk_tasklib-3.0.9.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+dk_tasklib-3.0.9.dist-info/entry_points.txt,sha256=3ay7Osx3BNuj1RbAquh72G6hTkL9FYNyydH1G45uT6M,72
+dk_tasklib-3.0.9.dist-info/top_level.txt,sha256=yG3xqUjpFZUCFf-_OhR5X2Is0NVbOW6e9YBmYnFlwhU,10
+dk_tasklib-3.0.9.dist-info/RECORD,,

dk_tasklib-3.0.9.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

dk_tasklib-3.0.9.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+dk-tasklib = dktasklib.entry_points.dktasklibcmd:main

dk_tasklib-3.0.9.dist-info/top_level.txt

@@ -0,0 +1 @@
+dktasklib

dktasklib/__init__.py

@@ -0,0 +1,3 @@
+from ._version import __version__   # noqa
+from .package import Package        # noqa
+from . import lessc                 # noqa

dktasklib/_version.py

@@ -0,0 +1 @@
+__version__ = '3.0.9'

dktasklib/clean.py

@@ -0,0 +1,8 @@
+from dktasklib.wintask import task
+
+
+@task
+def clean(ctx, directory):
+    """Remove all contents from build subdirectory `directory`.
+    """
+    ctx.run("rm -rf build/{directory}/*".format(directory=directory))

dktasklib/commands.py

@@ -0,0 +1,95 @@
+import os
+import re
+import invoke
+
+from .executables import exe
+from .utils import fmt
+
+
+default_command_policy = dict(
+    negative_bool='omit',   # omit False boolean parameters (or 'prefix')
+    list_join=',',
+)
+
+
+class Command:
+    def __init__(self, name, argspec="",
+                 requirements=(),
+                 policy=default_command_policy,
+                 **optdefs):
+        self._args = (name, argspec, requirements, policy, optdefs)
+        self._initialized = False
+
+    def _initialize(self):
+        if self._initialized:
+            return
+        name, argspec, requirements, policy, optdefs = self._args
+        # handle any required params attached to the command, i.e. if the
+        # command is specified as foo = Command('foo -v', ...)
+        exename, reqparams = (name + ' ').split(' ', 1)
+        # make sure all requirements are present
+        exe.require(*requirements)
+        if os.path.isfile(exename):         # if path to executable is given
+            self.cmd = exename              # then use it
+        else:
+            self.cmd = exe.find(exename)    # else search path
+        # fetch names of all argspec params
+        self.params = [p[1:-1] for p in re.findall(r'\{[^}]*\}', argspec)]
+        self.required_params = reqparams.strip()
+        self.argspec = argspec
+        self.policy = policy
+        self.optdefs = optdefs
+        self._initialized = True
+
+    def _kw_to_opts(self, kw):
+        res = ""
+        for k, v in kw.items():
+            if k in self.params:  # skip conversion of parameters to argspec
+                continue
+
+            res += ' '
+            flag = ('-' if len(k) == 1 else '--') + k.replace('_', '-')
+
+            if isinstance(v, bool):
+                if v:
+                    res += flag
+                else:
+                    if self.policy['negative_bool'] == 'prefix':
+                        res += '--no-' + flag.lstrip('-')
+
+            elif isinstance(v, (list, tuple)) and v:
+                res += flag + '=' + self.policy['list_join'].join(str(item) for item in v)
+
+            elif isinstance(v, str):
+                res += flag + '="%s"' % v
+
+            else:
+                res += flag + '=' + str(v)
+
+        return res
+
+    def __call__(self, ctx=None, *args, **kwargs):
+        self._initialize()
+        if ctx is not None and not isinstance(ctx, invoke.Context):
+            # we've been passed a real argument in position 0
+            args = (ctx,) + args
+            ctx = None
+
+        kwargs['opts'] = self._kw_to_opts(kwargs)
+        posargs = ' '.join(args)
+        if 'pos' in self.params:
+            kwargs['pos'] = posargs
+        fparams = fmt(self.argspec, kwargs)
+        if 'pos' not in self.params:
+            # if placement of positional args is not specified, then put at end
+            fparams += " " + posargs
+        if ctx is None:
+            ctx = invoke.Context()
+
+        cmd = '"%s"' % self.cmd if ' ' in self.cmd else self.cmd
+        cmd += ' ' + self.required_params + fparams
+        ctx.run(cmd, warn=True)
+        return cmd
+
+
+tree = Command('tree -I ".git|*.pyc|*.swp|dist|*.egg-info|_static|_build|_templates"')

dktasklib/concat.py

@@ -0,0 +1,76 @@
+import os
+import sys
+
+from dkfileutils.path import Path
+
+
+def line_endings(fname):
+    """Return all line endings in the file.
+    """
+    _endings = {line[-2:] for line in open(fname, 'rb').readlines()}
+    res = set()
+    for e in _endings:
+        if e.endswith(b'\r'):
+            res.add(b'\r')
+        elif e.endswith(b'\r\n'):
+            res.add(b'\r\n')
+        elif e.endswith(b'\n'):
+            res.add(b'\n')
+    return res
+
+
+def chomp(s):
+    """Remove line terminator if it exists.
+    """
+    if s[-2:] == b'\r\n':
+        return s[:-2]
+    if s[-1:] == b'\r' or s[-1:] == b'\n':
+        return s[:-1]
+    return s
+
+
+def fix_line_endings(fname, eol=b'\n'):
+    """Change all line endings to ``eol``.
+    """
+    lines = [chomp(line) for line in open(fname, 'rb').readlines()]
+    with open(fname, 'wb') as fp:
+        for line in lines:
+            fp.write(line + eol)
+
+
+def copy(ctx, source, dest, force=False):
+    """Copy ``source`` to ``dest``, which can be a file or directory.
+    """
+    if source == dest:
+        return dest
+
+    source = os.path.normcase(os.path.normpath(str(source)))
+    dest = os.path.normcase(os.path.normpath(str(dest)))
+    flags = ""
+    if sys.platform == 'win32':
+        if force:
+            flags += " /Y"
+        ctx.run('copy {flags} {source} {dest}'.format(**locals()))
+    else:  # pragma: nocover
+        if force:
+            flags += " --force"
+        ctx.run('cp {flags} {source} {dest}'.format(**locals()))
+    return dest
+
+
+def concat(ctx, dest, *sources, **kw):
+    force = kw.pop('force', False)      # noqa
+    placement = Path(dest).dirname()
+    placement.makedirs()
+
+    with open(dest, 'w') as out:
+        print("Opened:", dest, "for writing.")
+        for s in sources:
+            with open(s, 'r') as inp:
+                print("  appending:", s)
+                out.writelines(inp.readlines())
+        out.write('\n')
+
+    fix_line_endings(dest)
+
+    return dest

dktasklib/docs.py

@@ -0,0 +1,225 @@
+import datetime
+import os
+import sys
+import textwrap
+import webbrowser
+from os.path import join
+
+from dkfileutils.changed import changed
+from dkfileutils.path import Path
+
+from dktasklib.entry_points.pytemplate import PyTemplate
+from dktasklib.runners import run
+from dktasklib.wintask import task
+from invoke import Collection
+
+from dktasklib import concat
+from dktasklib import Package
+
+
+DIRNAME = Path(__file__).dirname()
+
+
+@task(name='clean')
+def _clean(ctx):  # Underscored func name to avoid shadowing kwargs in build()
+    """Nuke docs build target directory so next build is clean.
+    """
+    if 'pkg' not in ctx:
+        ctx.pkg = Package()
+    builddir = ctx.pkg.root / 'build' / 'docs'
+    if os.path.exists(builddir) and len(os.listdir(builddir)) > 0:
+        ctx.run("rm -rf {0}/*".format(builddir))
+
+
+# Ditto
+@task(name='browse')
+def _browse(ctx):  # pragma: nocover
+    """Open build target's index.html in a browser (using the :py:mod:`webbrowser` module).
+    """
+    index = join(ctx.pkg.root / 'build' / 'docs' / 'index.html')
+    webbrowser.open_new(index)
+
+
+@task(help=dict(
+    author='full name of author',
+    language='two letter language code (en, no, etc.)',
+
+))
+def initdocs(ctx, author, language):
+    """Run sphinx-quickstart to create an initial docs folder.
+    """
+    pkg = Package()
+    cmd = (
+        'sphinx-quickstart '
+        ' --dot _'
+        ' -a "{author}"'
+        ' -l {language}'
+        ' -v {pkg.version}'
+        ' -r {pkg.version}'
+        ' -p {pkg.name}'
+        ' --no-makefile'
+        ' --no-batchfile'
+        ' --ext-autodoc'
+        ' --ext-intersphinx'
+        ' --ext-todo'
+        ' --ext-viewcode'
+        ' --suffix=".rst"'
+        ' --master="index"'
+        ' {docsdir}'
+    ).format(
+        pkg=pkg,
+        docsdir=pkg.docs.relpath(pkg.root),
+        author=author,
+        language=language,
+    )
+    print("""
+
+    invoke can't run this command on windows..
+
+    {cmd}
+    """.format(cmd=cmd))
+
+
+@task
+def create_docs_directory(ctx, force=False):
+    """Create docs/conf.py
+    """
+    cwd = Path.curdir()     # noqa
+    ctx.pkg.docs = ctx.pkg.docs
+    if ctx.pkg.docs.exists() and not force:
+        print("docs directory exists (use --force to overwrite)")
+        sys.exit(1)
+    ctx.pkg.docs.makedirs()
+    ctx.pkg.docs.makedirs('_static')
+    ctx.pkg.docs.makedirs('_templates')
+    confbase = DIRNAME / 'entry_points/confbase.py'
+    txt = confbase.read('rb')
+    txt = txt.replace(b'\r\n', b'\n')
+    t = PyTemplate(txt)
+
+    (ctx.pkg.docs / 'conf.py').write(t.substitute(
+        VERSION=ctx.pkg.version,
+        PACKAGE=ctx.pkg.name,
+        YEAR=datetime.date.today().year,
+        AUTHOR=run('python setup.py --author').strip()
+    ))
+
+
+@task
+def create_index(ctx, force=False):
+    """Create docs/index.rst
+    """
+    index = ctx.pkg.docs / 'index.rst'
+    if index.exists() and not force:
+        print("docs/index.rst exists (use --force to overwrite)")
+        sys.exit(1)
+    confbase = DIRNAME / 'entry_points/index.rst'
+    txt = confbase.read('rb')
+    txt = txt.replace(b'\r\n', b'\n')
+    t = PyTemplate(txt)
+
+    index.write(t.substitute(
+        PACKAGE=ctx.pkg.name,
+        SOURCEDIR=ctx.pkg.source,
+    ))
+
+
+@task
+def make_api_docs(ctx, prefix='', force=False):
+    """Run sphinx-apidoc to write autodoc documentation to `docs/api/*`
+    """
+    ctx.run("rm -rf {pkg.docs}/api".format(pkg=ctx.pkg))
+    ctx.run("sphinx-apidoc -o {pkg.docs}/api {pkg.source} {pkg.source}/migrations {pkg.source}/models {pkg.source}/models.py".format(pkg=ctx.pkg))
+    if prefix:
+        for fname in (ctx.pkg.docs / 'api').glob('*.rst'):
+            f = Path(fname)
+            lines = f.read().split('\n')
+            for i, line in enumerate(lines):
+                lines[i] = line.replace(ctx.pkg.name, prefix + ctx.pkg.name)
+                if i > 0 and len(set(line)) == 1 and len(line) < len(lines[i-1]):
+                    lines[i] = line[0] * len(lines[i-1])
+            f.write('\n'.join(lines))
+            pre, pkgname, post = fname.rpartition(ctx.pkg.name)
+            if pkgname and os.path.sep not in post:
+                f.rename(pre + prefix + pkgname + post)
+
+    concat.copy(ctx, ctx.pkg.docs / 'api' / '*', ctx.pkg.docs)
+    ctx.run("rm -rf {pkg.docs}/api".format(pkg=ctx.pkg))
+
+    if ".. include:: modules.rst" not in open(ctx.pkg.docs / 'index.rst').read():
+        print(textwrap.dedent("""\
+        WARNING: you need to include the following in docs/index.rst
+
+            .. include:: modules.rst
+
+        """))
+
+
+@task(default=True, help={
+    'opts': "Extra sphinx-build options/args",
+    'prefix': "Module prefix, for submodules",
+    'clean': "Remove build tree before building",
+    'browse': "Open docs index in browser after building",
+    'warn': "Build with stricter warnings/errors enabled",
+    'builder': "Builder to use, defaults to html",
+    'force': "Force re-reading of all files (ignore cache)",
+})
+def build(ctx, clean=False, browse=False, warn=False,
+          builder='html',
+          force=False,
+          opts="", prefix=''):
+    """
+    Build the project's Sphinx docs.
+    """
+    if not force and not changed(ctx.pkg.docs):
+        print("""
+        No changes detected in {}, add --force to build docs anyway.
+        """.format(ctx.pkg.docs))
+        return  # should perhaps check if code has changed too? (autodoc)
+
+    if clean:
+        _clean(ctx)
+    make_api_docs(ctx, force=force, prefix=prefix)
+
+    if opts is None:  # pragma: nocover
+        opts = ""
+    opts += " -b %s" % builder
+    if warn:
+        opts += " -n -W"
+    if force:
+        opts += " -a -E"
+    cmd = "sphinx-build {opts} {ctx.pkg.docs} {ctx.pkg.root}/build/docs".format(opts=opts, ctx=ctx)
+    dj_settings = ctx.pkg.get('django_settings_module', "")
+    if dj_settings:
+        os.environ['DJANGO_SETTINGS_MODULE'] = dj_settings
+    ctx.run(cmd)
+    if browse:  # pragma: nocover
+        _browse(ctx)
+
+
+@task
+def tree(ctx):
+    """Display the docs tree.
+    """
+    ignore = ".git|*.pyc|*.swp|dist|*.egg-info|_static|_build|_templates"
+    ctx.run('tree -Ca -I "{0}" {1}'.format(ignore, ctx.pkg.docs))
+
+
+# Vanilla/default/parameterized collection for normal use
+ns = Collection(
+    'docs',
+    _clean,
+    _browse,
+    build,
+    tree,
+    initdocs,
+    create_docs_directory,
+    create_index,
+)
+ns.configure({
+    'docs': {
+        'source': 'docs',
+        'builddir': join('build', 'docs'),
+        'target_file': 'index.html',
+    }
+})

dktasklib/entry_points/__init__.py

@@ -0,0 +1,5 @@
+"""
+"""
+
+if __name__ == "__main__":
+    pass