diff options
Diffstat (limited to 'website/content/platform/development/contributor-guidelines/sharing_extensions.md')
-rw-r--r-- | website/content/platform/development/contributor-guidelines/sharing_extensions.md | 61 |
1 files changed, 0 insertions, 61 deletions
diff --git a/website/content/platform/development/contributor-guidelines/sharing_extensions.md b/website/content/platform/development/contributor-guidelines/sharing_extensions.md deleted file mode 100644 index 0f99dab13f1..00000000000 --- a/website/content/platform/development/contributor-guidelines/sharing_extensions.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Sharing Your Extension -sidebar_position: 4 -description: This guide provides detailed instructions on how to share your custom OpenBB extension with the community by publishing it on PyPI. -keywords: -- OpenBB extensions -- PyPI publishing -- Extension sharing -- Custom extension -- OpenBB community ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - -<HeadTitle title="Sharing Your Extension - Contributor Guidelines - Development | OpenBB Platform Docs" /> - -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: - -```bash -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: - -```bash -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: - -```bash -pip install dist/openbb_[FILE_NAME].whl -``` - -### Publish - -To publish your package to PyPI run: - -```bash -poetry publish -``` - -Now, you can pip install your package from PyPI with: - -```bash -pip install openbb-some_ext -``` |