dkpkg package

Submodules

dkpkg.directory module

Programatic interface to package structure.

Use the Package class.

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

Bases: object

Default package directory layout (consider this abstract, both in the

sense that this class is abstract and in the sense that this is the attribute names of this object, not neccessarily the actual directory name)

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

KEYS = {'build', 'build_coverage', 'build_docs', 'build_lintscore', 'build_meta', 'build_pytest', 'django_models', 'django_static', 'django_templates', 'docs', 'location', 'name', 'package_name', 'source', 'source_js', 'source_less', 'tests', 'tests_js'}

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_models

Return the path to the Django models.

django_models_dir = None

The django models directory

django_models_py = None

the django models.py file

django_static = None

The django app static directory.

django_templates = None

The django app template directory.

docs = None

The documentation source directory.

is_django()

Is this a Django package?

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.

public_dir = None

Gitlab public directory.

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.

tests_js = None

the javascript tests directory

write_ini(_fname, section)

Write to ini file.

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

Bases: dkpkg.directory.DefaultPackage

Package layout with possible overrides.

Module contents

A common naming scheme for the parts of a Python package.