Skip to main content

Sharing Your Extension

We encourage you to share your extension with the community. You can do that by publishing it to PyPI.

Publish your extension to PyPI​

To publish your extension to PyPI, you'll need to have a PyPI account and a PyPI API token.

Setup​

Create an account and get an API token from https://pypi.org/manage/account/token/

Store the token with:

poetry config pypi-token.pypi pypi-YYYYYYYY

Release​

cd into the directory where your extension pyproject.toml lives and make sure that the pyproject.toml specifies the version tag you want to release and run:

poetry build

This will create a /dist folder in the directory, which will contain the .whl and tar.gz files matching the version to release.

If you want to test your package locally you can do it with:

pip install dist/openbb_[FILE_NAME].whl

Publish​

To publish your package to PyPI run:

poetry publish

Now, you can pip install your package from PyPI with:

pip install openbb-some_ext

On this page