BUILD.md

Build

Generate a pyenv-virtualenv (recommended)

To have an own isolated environment for project, using pyenv-virtualenv is recommended, follow this documentation for installation.

pyenv virtualenv 3.12.2 edream_sdk

And then activate it

pyenv activate edream_sdk

Install requirements

pip install -r requirements.txt

Install build tool (skip, already installed on requirements)

First, install the build tool:

pip install build

Build package

Build the package

python -m build

This command generates distribution archives in the dist/ directory. You’ll get:

• A source distribution (.tar.gz)
• A wheel distribution (.whl)

Installation package from local build

The installer tool is used to install packages from distribution archives, which is a more modern alternative to using pip install . directly.

First, install the installer tool (skip, already installed on requirements):

pip install installer

Install package

To install a package from a distribution archive, use:

python -m installer dist/edream_sdk-0.1.0-py3-none-any.whl

Uninstall package

If you need to uninstall the package locally, execute next command

pip uninstall edream_sdk

Publish package

Pending...