jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 04:52:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
565cafba53d74a705a708eaaa424eb35e2f36b1e
OpenBB/website/content/platform/contributing/developer-guidelines/build_openbb_extensions.md
Danglewood 757fc57174 docs/fix-urls: Updates the Terminal About URLs to match /develop (#5720) 
* 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>
2023-11-16 17:02:59 -05:00

1.7 KiB
Vendored
Raw Blame History

title, sidebar_position, description, keywords
title sidebar_position description keywords
Building Extensions for OpenBB Platform 2 This guide provides a comprehensive walkthrough on how to create custom extensions for the OpenBB Platform. It covers the process from generating the extension structure to sharing it with the community.
OpenBB Platform
Custom extension
Python development
Data integration
Community contribution

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

We have a Cookiecutter template that will help you get started. It serves as a jumpstart for your extension development, so you can focus on the data and not on the boilerplate.

Please refer to the Cookiecutter template and follow the instructions there.

This document will walk you through the steps of adding a new extension to the OpenBB Platform.

The high level steps are:

  • Generate the extension structure
  • Install your dependencies
  • Install your new package
  • Use your extension (either from Python or the API interface)
  • QA your extension
  • Share your extension with the community

Best Practices

  1. Review Platform Dependencies: Before adding any dependency, ensure it aligns with the Platform's existing dependencies.
  2. Use Loose Versioning: If possible, specify a range to maintain compatibility. E.g., >=1.4,<1.5.
  3. Testing: Test your extension with the Platform's core to avoid conflicts. Both unit and integration tests are recommended.
  4. Document Dependencies: Use pyproject.toml and poetry.lock for clear, up-to-date records.