Skip to content

Commit

Permalink
Add devtools metapackage (#5703)
Browse files Browse the repository at this point in the history
* Add openbb-devtools metapackage

* adding devtools to the dev_install script

---------

Co-authored-by: hjoaquim <[email protected]>
  • Loading branch information
piiq and hjoaquim authored Nov 10, 2023
1 parent 3f1c990 commit a40b47e
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 0 deletions.
1 change: 1 addition & 0 deletions openbb_platform/dev_install.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
LOCAL_DEPS = """
[tool.poetry.dependencies]
python = ">=3.8,<3.12"
openbb-devtools = { path = "./extensions/devtools", develop = true }
openbb-provider = { path = "./platform/provider", develop = true }
openbb-core = { path = "./platform/core", develop = true }
Expand Down
22 changes: 22 additions & 0 deletions openbb_platform/extensions/devtools/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# The OpenBB DevTools Extension

This extension aggregates the dependencies that facilitate a nice development experience
for OpenBB. It does not contain any code itself, but rather pulls in the following dependencies:

- Linters (ruff, pylint, mypy)
- Code formatters (black)
- Code quality tools (bandit)
- Pre-commit hooks (pre-commit)
- CI/CD configuration (tox, pytest, pytest-cov)
- Jupyter kernel (ipykernel)
- ... add your productivity booster here ...

## Installation

The extension is included into the dev_install.py script.

Standalone installation:

```bash
pip install openbb-devtools
```
Empty file.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"""Placeholder for openbb_devtools."""
29 changes: 29 additions & 0 deletions openbb_platform/extensions/devtools/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
[tool.poetry]
name = "openbb-devtools"
version = "0.1.0"
description = "Tools for OpenBB Platform Developers"
authors = ["OpenBB Team <[email protected]>"]
readme = "README.md"
packages = [{ include = "openbb_devtools" }]

[tool.poetry.dependencies]
python = ">=3.8,<3.12" # scipy forces <4.0 explicitly
ruff = "^0.1.5"
pylint = "^3.0.2"
mypy = "^1.6.1"
pydocstyle = "^6.3.0"
black = "^23.11.0"
bandit = "^1.7.5"
pre-commit = "^3.5.0"
tox = "^4.11.3"
pytest = "^7.4.3"
pytest-cov = "^4.1.0"
ipykernel = "^6.26.0"
types-python-dateutil = "^2.8.19.14"
types-toml = "^0.10.8.7"
poetry = "^1.7.0"


[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

0 comments on commit a40b47e

Please sign in to comment.