Skip to content

DEVELOP.md

Latest commit

 

History

History
62 lines (52 loc) · 1.49 KB

DEVELOP.md

File metadata and controls

62 lines (52 loc) · 1.49 KB
Raw

Development Documentation

Set up sandbox

git clone https://github.com/crate/langchain-cratedb.git
cd langchain-cratedb
poetry install --with lint,test,typing

Run CrateDB

docker run --rm \
  --publish=4200:4200 --publish=5432:5432 --env=CRATE_HEAP_SIZE=2g \
  crate:latest -Cdiscovery.type=single-node

Validate codebase

Run linters and software tests.

make check

Format code.

make format

Software tests

Run tests selectively.

pytest -vvv tests/test_docs.py tests/test_examples.py
pytest -vvv -k standard
pytest -vvv -k cratedb

Release

  • Bump version in pyproject.toml's tool.poetry.version.
  • Update CHANGES.md correspondingly.
  • Commit both files with Release 0.2.0.
  • Tag repository git tag v0.2.0.
  • Build and upload package. 
    poetry build
twine upload --skip-existing dist/*{.tar.gz,.whl}

Genesis

This package has been bootstrapped using langchain-cli integration new, see also How to implement an integration package.

Other fragments have been derived from langchain-datastax, langchain-mongodb, and langchain-postgres.