c047cfeddd
* move old example notebooks to v3 folder, update loadHistoricalPriceData and add findSymbols * Create README.md * Update README.md * Update README.md * Update README.md * Vertical diagram instead * important classes * core dependencies * folder structure * devtools * swap order * fix github pages deploy issue * development index * delete expectations for developers * devtools * obbject stuff * add * installation * hub sync * idk if i committed already * add usage page for financial statements * add link to reference page * syntax * numbers * nearly --> more than * easier to read code blocks * codespell * removing mention to provider * add 'orientation' for to_dict * info card for output user preference * put it in a code block * correct user_settings.json example * syntax corrections * fix sentence * get rid of floating point mathc * get rid of other floating point math * add companion example notebook for financial statements, and new section * historical prices usage page * codespell * add commitment of traders section to usage * add a note * codespell * get rid of equals sign * Cleanup docs. with @the-praxs * install * obbject extend * spell * HeadTitle thingies * Update obbject_extensions.md * Update obbject_extensions.md * typo * Update architectural_considerations.md * point to the TET pattern * optional vs required * reviewing the patterns. removed the --pre flag under the assumption this will be the final docs for the release cc @deeleeramone * add a walkthrough * spelling * Add more in the introduction * validator examples * update Copper-to-Gold notebook example for V4 * Update README.md * QA Caveats w @the-praxs * info on class outputs * merge add data sources and add data points * disclaimer on cookiecutter * add missing import to example * slight syntax change * missing code block * missing import * update intrinio example syntax * intrinio syntax update * urls * core and provider merged * example syntax * grammar * Update API banner link * quick-fix-docs cc @minhhoang1023 * Update pip install command for v3 * remove --pre note block * update landing image --------- Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: Luqman <luqazino@gmail.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
2.7 KiB
Vendored
title, sidebar_position, description, keywords
| title | sidebar_position | description | keywords | |||||
|---|---|---|---|---|---|---|---|---|
| DevTools | 2 | This page provides information about the `openbb-devtools` package, which includes a range of dependencies essential for robust and efficient software development on the OpenBB Platform. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
Please refer to the following PyPI distributed package: https://pypi.org/project/openbb-devtools/
This Python package, openbb-devtools, is designed for OpenBB Platform Developers and contains a range of dependencies essential for robust and efficient software development.
These dependencies cater to various aspects like code formatting, security analysis, type checking, testing, and kernel management.
The inclusion of these packages ensures that the development process is streamlined, the code quality is maintained, and the software is secure and reliable.
Included dependencies:
ruff: A fast Python linter focused on performance and simplicity.pylint: A tool that checks for errors in Python code, enforces a coding standard, and looks for code smells.mypy: A static type checker for Python, helping catch type errors during development.pydocstyle: A linter for Python docstrings to ensure they meet certain style requirements.black: An uncompromising Python code formatter, ensuring consistent code style.bandit: A tool designed to find common security issues in Python code.pre-commit: Manages and maintains pre-commit hooks that run checks before each commit, ensuring code quality.nox: A generic virtualenv management and test command line tool for running tests in isolated environments.pytest: A mature full-featured Python testing tool that helps in writing better programs.pytest-cov: A plugin for pytest that measures code coverage during testing.ipykernel: A package that provides the IPython kernel for Jupyter.types-python-dateutil: Type stubs for python-dateutil, aiding in static type checking.types-toml: Type stubs for TOML, useful for static type checking in TOML parsing.poetry: A tool for dependency management and packaging in Python.
Each dependency plays a critical role in ensuring the code is clean, efficient, and functional, ultimately leading to the development of high-quality software.
While developing code for the OpenBB Platform, one should always install the DevTools packages so that the above development tooling is available out-of-the-box.
:::info
When setting up the environment using the openbb_platform/dev_install.py script, the DevTools will also be installed.
:::