build package — python-build 0.0.4 documentation

# build package

## Submodules

- build.env module

## Module contents

python-build - A simple, correct PEP517 package builder

exception `build.` `BuildBackendException`

  Bases: `Exception`

  Exception raised when the backend fails

exception `build.` `BuildException`

  Bases: `Exception`

  Exception raised by ProjectBuilder

exception `build.` `IncompleteCheckWarning`

  Bases: `Warning`

  Warning raised when we have an incomplete check

class `build.` `ProjectBuilder`(srcdir='.', config_settings=None)

  Bases: `object`

  `build`(distribution, outdir)

    Builds a distribution

    Parameters

      - distribution (`str`) – Distribution to build (sdist or wheel)

      - outdir (`str`) – Outpur directory

    Return type

      `None`

  property `build_dependencies`
    Return type

      `Set`[`str`]

  `check_dependencies`(distribution)

    Returns a set of the missing dependencies

    Parameters

      distribution (`str`) – Distribution to build (sdist or wheel)

    Return type

      `Set`[`str`]

  `get_dependencies`(distribution)

    Returns a set of dependencies

    Return type

      `Set`[`str`]

exception `build.` `TypoWarning`

  Bases: `Warning`

  Warning raised when a potential typo is found

`build.` `check_version`(requirement_string, extra='')
  Parameters

    - requirement_string (`str`) – Requirement string

    - extra (`str`) – Extra (eg. test in myproject[test])

  Return type

    `bool`