Peak SDK

phase pre-commit Black

Overview

  • This is the official Python SDK for the entire Peak platform, and is currently in the stable state. All users are encouraged to participate in the development process by providing feedbacks, submitting issues and pull requests. 🙏

Installation

You can install Peak SDK via [pip] from [PyPI] (not yet available)) or from source, the only requirement is Python 3.8+:

  • Installation from a source branch or tag

    $ pip install "peak @ git+https://github.com/PeakBI/peak-sdk.git@{branch-name-or-tag}"

  • Installation from [PyPI] (not yet available)

    $ pip install peak-sdk

  • Installing the CLI extra

    • From source branch or tag:

    $ pip install "peak[cli] @ git+https://github.com/PeakBI/peak-sdk.git@{branch-name-or-tag}"

    • From [PyPI] (not yet available):

    $ pip install peak-sdk[cli]

    • Once CLI is installed, you can enable auto-completion for your shell by running peak --install-completion ${shell-name} command, where shell can be one of [bash|zsh|fish|powershell|pwsh].

    • Note: Make sure that compinit is called once in your shell configuration file, and that the compinit command is placed after the autoload command block that loads the completion script.

Platform Support

Support across Python versions on major 64-bit platforms
Python Version Linux MacOS Windows
3.8 🟢 🟡 🟤
3.9 🟢 🟡 🟤
3.10 🟢 🟢 🟤
Legend
Key Status Description
🟢 Supported regularly tested, and fully supported
🟡 Limited Support not explicitly tested but should work, and supported on a best-effort basis
🟤 Not Tested should work, but no guarantees and/or support

Documentation

Documentation best seen on Peak SDK, or can be served locally by running :point_down:

$ poetry install --no-interaction --no-ansi --with docs,jupyter --extras cli
$ poetry run nox --session=autodocs

If browsing on github you can check out the docs online and browse the raw markdown files.

Usage

Please see the usage documentation for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the Apache 2.0 license, Peak SDK is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Changelogs

The changelogs can be found in the Changelogs file.

  • Only tracks changes from v0.0.3 onwards, for previous changelogs please see individual releases on github.