dkpkg package

Submodules

dkpkg.directory module

Programatic interface to package structure.

class dkpkg.directory.DefaultPackage(root, **kw)

Bases: object

Default package directory layout (consider this abstract)

<parent>                      # self.location (abspath)
   |--<name>                  # self.root (abspath), self.package_name
        |-- build             # self.build
        |   |-- coverage      # self.build_coverage
        |   |-- docs          # self.build_docs
        |   |-- lintscore     # self.build_lintscore
        |   |-- meta          # self.build_meta
        |   `-- pytest        # self.build_pytest
        |-- <name>            # <name> == self.name, self.source
        |   |-- js            # self.source_js
        |   |-- less          # self.source_less
        |   |-- static        # self.django_static
        |   `-- templates     # self.django_templates
        |-- docs              # self.docs
        +-- tests             # self.tests
        +-- setup.py          #
        `-- requirements.txt  #

KEYS = set(['source_js', 'tests', 'build_docs', 'django_templates', 'package_name', 'location', 'docs', 'build_lintscore', 'name', 'source', 'build_pytest', 'build', 'source_less', 'build_meta', 'django_static', 'build_coverage'])

A set of all overridable keys

all_dirs

Return all package directories.

build = None

The root of the build output directory.

build_coverage = None

Coverage output directory.

build_dirs

Directories containing build artifacts.

build_docs = None

Documentation output directory.

build_lintscore = None

Lintscore output directory.

build_meta = None

Package meta output directory.

build_pytest = None

Pytest output directory.

django_dirs

Directories containing/holding django specific files.

django_static = None

The django app static directory.

django_templates = None

The django app template directory.

docs = None

The documentation source directory.

location = None

The abspath of the directory containing the root.

make_missing()

Create all missing directories.

missing_dirs()

Return all missing directories.

name = None

The importable name.

package_name = None

The pip-installable name.

root = None

The abspath to the “working copy”.

source = None

The source directory.

source_dirs

Directories containing source.

source_js = None

The javascript source directory.

source_less = None

The less source directory.

tests = None

The tests directory.

write_ini(fname, section)

Write to ini file.

class dkpkg.directory.Package(root, name=None, docs=None, tests=None, build=None, source=None, source_js=None, source_less=None, build_coverage=None, build_docs=None, build_lintscore=None, build_meta=None, build_pytest=None, django_templates=None, django_static=None, **kw)

Bases: dkpkg.directory.DefaultPackage

Package layout with possible overrides.

Module contents