Files
OpenBB/website/content/platform/contributing/extension-development/share_extension.md
Igor Radovanovic 83aa83f988 Improve SEO
2023-10-03 17:27:17 +02:00

1.4 KiB
Vendored

title, sidebar_position, description, keywords
title sidebar_position description keywords
Share your extension 4 How to share your extension with the community.
openbb platform
introduction
share
extension
contributing
documentation
PyPI
community

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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