dlab_core.setup

Module Contents

AUTHOR_EMAIL = dev@dlab.apache.org

author of the package

AUTHOR = Apache Software Foundation

Gives the index and pip some additional metadata about your package. In this case, the package is only compatible with Python 3, is licensed under the MIT license, and is OS-independent. You should always include at least which version(s) of Python your package works on, which license your package is available under, and which operating systems your package will work on. For a complete list of classifiers, see https://pypi.org/classifiers/.

CLASSIFIERS = ['Development Status :: 1 - Planning ', 'Environment :: Console', 'Intended Audience :: Developers', 'Intended Audience :: System Administrators', 'License :: OSI Approved :: Apache Software License', 'Programming Language :: Python', 'Topic :: Software Development', 'Topic :: Software Development :: Build Tools', 'Topic :: Software Development :: Libraries', 'Topic :: Software Development :: Libraries :: Python Modules', 'Topic :: System :: Clustering', 'Topic :: System :: Software Distribution', 'Topic :: System :: Systems Administration']

Type of markup is used for the long description. In this case, it’s Markdown.

DESCRIPTION_CONTENT_TYPE = text/markdown

Text indicating the license covering the package where the license is not a selection from the “License” Trove classifiers. See the Classifier field. Notice that there’s a licence distribution option which is deprecated but still acts as an alias for license.

LICENSE = Apache-2.0

Appropriate PEP 440 version specifier string will prevent pip from installing the project on other Python versions

PYTHON_REQUIRES

URL for the homepage of the project. For many projects, this will just be a link to GitHub, GitLab, Bitbucket, or similar code hosting service.

URL = https://github.com/apache/incubator-dlab

Version file name location

VERSION_FILE = __version__.py

Readme file location

README_FILE = README.md

requirements.txt file location

REQUIREMENTS_FILE = requirements.txt

exception SetupException

Bases: Exception

Class for Setup exceptions.

exception FileNotFoundException

Bases: OSError

Exception class thrown when a file couldn’t be found

class SetupParametersDirector

Construct an parameters dict using the BaseSetupParametersBuilder interface.

parameters

Get parameters list as dict for setup.py

Returns:dict

build(self, builder)

Build setup parameters.

Parameters:builder (BaseSetupParametersBuilder) – Parameters builder. Returns:None

class SetupParametersBuilder(name, description)

Bases: object

Creating parts of a setup parameters dict see PEP 561 for more details about Distributing and Packaging Type Information

entry_points

Get setup entry points

Returns:dict

package_data

Get setup package data

Returns:dict

parameters

Get parameters list as dict for setup.py

Returns:dict

lib_file

Get library file location.

Returns:str

version_file

Get version file location.

Returns:str

static _read_file(name)

Get content by filename.

Parameters:name (str) – File location. Returns:str

set_packages(self)

Set list of all Python import packages that should be included in the distribution package. Instead of listing each package manually, we can use find_packages() to automatically discover all packages and subpackages. In this case, the list of packages will be example_pkg as that’s the only package present.

Returns:None

set_requirements(self)

Set libraries list that should be used to specify what a project minimally needs to run correctly. When the project is installed by pip, this is the specification that is used to install its dependencies.

Returns:None

set_version(self)

Set package version see PEP 440 for more details on versions.

Returns:None

set_long_description(self)

Set detailed description of the package. This is shown on the package detail package on the Python Package Index. In this case, the long description is loaded from README.md which is a common pattern.

Returns:None

set_entry_points(self)

A dictionary mapping entry point group names to strings or lists of strings defining the entry points. Entry points are used to support dynamic discovery of services or plugins provided by a project. See Dynamic Discovery of Services and Plugins for details and examples of the format of this argument. In addition, this keyword is used to support Automatic Script Creation.

Returns:None

set_package_data(self)

Include package data :return: None