757fc57174
* update Terminal about URLs and some other broken links
* ruff
* intro
* changing the heading levels
* dependency management sections
* structure
* developer guides
* structure
* contributor guides
* keywords and descriptions
* broken urls
* cool cards
* Cool cards (#5727)
* tidy up terminal/content
* some more tidy up
* fix styling for platform that was missing
* more tidy up
* improve color for dark and light mode
* create new reference card for more basic cards
* rename back to menus
* implement all index.md for terminal, except reference
* improve bot title
* more refactoring
* fix remaining index
* header styling
* more styling
* heheheheheheeh
* Revert "heheheheheheeh"
This reverts commit 7d095fcfd2.
* Ccards (#5733)
* links
* more links
* improved styling and chevron aligned to title
* fix index.mdx urls for Terminal
* update package.json
* update index.mdx
* fix generation
* spelling
* toolkit_extensions
* update data extensions
* couple of links
* add tiingo to data extensions list
---------
Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
1.5 KiB
Vendored
title, sidebar_position, description, keywords
| title | sidebar_position | description | keywords | |||||
|---|---|---|---|---|---|---|---|---|
| Sharing Your Extension | 4 | This guide provides detailed instructions on how to share your custom OpenBB extension with the community by publishing it on PyPI. |
|
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