Chainbase is a library for instantly creating langchain-based APIs with autoconfiguration for proprietary data.
Project description
Getting Started
To get started with chainbase
for your application, visit the docs at https://chainbase.erob.io/
To contribute to chainbase
, see the contributing section below.
Contributing
Getting Started Locally
-
Launch postgres and pgadmin via docker-compose
docker-compose up --build
. -
Keeping your containers running, open a new terminal with the root of this repo as the working directory. Install
poetry
:pip install poetry
(or usepipx
on link here if you prefer isolated envs, or consider usingconda
). -
Create and enter the virtual environment:
poetry shell
-
Install the dependencies
poetry install
-
Start the app:
uvicorn examples.example_app:auto_app --reload
. -
Open
localhost:8000/v1/docs
and start interacting with swagger! -
You can shut down and your db / minio data will persist via docker volumes.
MinIO
- The MinIO console is available at
localhost:9001
. Login with user:miniouser
and password:minioadmin
if you launched the containers withdocker-compose up --build
.
Hooks and Tests
-
Set up the precommit hook with
pre-commit install
. -
Run tests and get coverage with
pytest --cov
, and get html reports for vs code live server (or any server) withpytest --cov --cov-report=html:coverage_re
-
Open a pull request against the repo! Please write tests, your coverage will automatically be added as a comment to any PR via GH actions.
Viewing Docs Locally
- Install docs dependencies with
pip install -r requirements-docs.txt
. - Install
mkdocs
withpip install mkdocs-material
. - Move into the
docs/en
directory viacd docs/en
. - Run
mkdocs serve
to start a local server.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for chainbase-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4c12806ea7ae26e4e0f93ebde961383fb23b4e18731a09eaeeb7c770896b062 |
|
MD5 | 9610489c0dd11116d0f024d694f23a13 |
|
BLAKE2b-256 | 1f1c184767226583959a4f93ffc1fd6395da6735260231db31a380cc296fdbfe |