Skip to content

Commit

Permalink
The llamaindex cli package (run-llama#10723)
Browse files Browse the repository at this point in the history
* llamaindex cli package

* BUILD to pass tests

* generate pants BUILD files

* add skip tests

* use llamaindex-cli name

* CHANGELOG
  • Loading branch information
nerdai authored Feb 15, 2024
1 parent f2d9472 commit 2ddd720
Show file tree
Hide file tree
Showing 31 changed files with 8,421 additions and 0 deletions.
153 changes: 153 additions & 0 deletions llama-index-cli/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
llama_index/_static
.DS_Store
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
bin/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
etc/
include/
lib/
lib64/
parts/
sdist/
share/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
.ruff_cache

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints
notebooks/

# IPython
profile_default/
ipython_config.py

# pyenv
.python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
pyvenv.cfg

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# Jetbrains
.idea
modules/
*.swp

# VsCode
.vscode

# pipenv
Pipfile
Pipfile.lock

# pyright
pyrightconfig.json
5 changes: 5 additions & 0 deletions llama-index-cli/BUILD
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
python_sources()

poetry_requirements(
name="poetry",
)
5 changes: 5 additions & 0 deletions llama-index-cli/CHANGELOG.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# CHANGELOG

## [0.1.0] - 2024-02-15

- Initial release of cli (ripped out from core)
17 changes: 17 additions & 0 deletions llama-index-cli/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
GIT_ROOT ?= $(shell git rev-parse --show-toplevel)

help: ## Show all Makefile targets.
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-30s\033[0m %s\n", $$1, $$2}'

format: ## Run code autoformatters (black).
pre-commit install
git ls-files | xargs pre-commit run black --files

lint: ## Run linters: pre-commit (black, ruff, codespell) and mypy
pre-commit install && git ls-files | xargs pre-commit run --show-diff-on-failure --files

test: ## Run tests via pytest.
pytest tests

watch-docs: ## Build and watch documentation.
sphinx-autobuild docs/ docs/_build/html --open-browser --watch $(GIT_ROOT)/llama_index/
30 changes: 30 additions & 0 deletions llama-index-cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# LlamaIndex CLI

## Installation

```sh
pip install llama-index-cli
```

## Usage

```sh
llamaindex -h

usage: llamaindex [-h] {rag,download-llamapack,download-llamadataset,upgrade,upgrade-file,new-package} ...

LlamaIndex CLI tool.

options:
-h, --help show this help message and exit

commands:
{rag,download-llamapack,download-llamadataset,upgrade,upgrade-file,new-package}
rag Ask a question to a document / a directory of documents.
download-llamapack Download a llama-pack
download-llamadataset
Download a llama-dataset
upgrade Upgrade a directory containing notebooks or python files.
upgrade-file Upgrade a single notebook or python file.
new-package Initialize a new llama-index package
```
1 change: 1 addition & 0 deletions llama-index-cli/llama_index/cli/BUILD
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
python_sources()
Empty file.
Loading

0 comments on commit 2ddd720

Please sign in to comment.