Skip to content

Latest commit

 

History

History
110 lines (77 loc) · 3.52 KB

DEVELOPING.md

File metadata and controls

110 lines (77 loc) · 3.52 KB
Raw

Steamship-Langchain

We are excited to have you on board!

These instructions contain the setup for contributors fo the Steamship client library for Langchain.

For information about using this library, please see README.md

Basic Information

  • 🐍 The project targets Python 3.8
  • ✍️ Code formatting is performed with black and isort
  • ♻️ Continuous integration is performed via GitHub Actions
  • ✅ Code linting is automated via pre-commit hooks: bandit, darglint, flake8, mypy, pre-commit-hooks, pydocstyle, pygrep-hooks, pyupgrade, safety, and shellcheck
  • 📋 Testing is automated via Pyunit
  • 🧑‍💻 We recommend PyCharm as a development environment

Development Setup

Set up virtual environment

First make sure you have Python3.8 -- the officially supported version

We highly recommend using virtual environments for development. Set up your virtual environment using the following commands:

python3.8 -m venv .venv
source .venv/bin/activate
python3.8 -m pip install -r requirements.txt
python3.8 -m pip install -r requirements.dev.txt

This will install the required dependencies (runtime and development) and register the project source tree with your virtual environment so that import steamship statements will resolve correctly.

Set up pre-commit-hooks

We use pre-commit hooks to validate coding standards before submission to code review. To make sure your code is always validated before each commit, please install the required git hook scripts as follows:

pre-commit install

Once completed the pre-commit hooks wil run automatically on git commit.

When pre-commit hooks make file modifications, the git commit command that triggered them will fail and need to be run again. Simply run the command multiple times until it succeeds.

You can run the pre-commit hooks manually via:

pre-commit run --all-files

Set your IDE to use proper Docstrings

Steamship uses PyCharm for Python development.

In PyCharm:

  • Navigate to Preferences -> Tools -> Python Integrated Tools -> Docstring Format
  • Select "NumPy" as the Docstring Format.

Testing

Configuring Test Credentials

The tests include integration tests that are intended to be performed against a running Steamship server. They all execute by loading the test profile from your Steamship client configuration.

To establish a test profile, edit your ~/.steamship.json file to ensure it has the following:

{
  "profiles": {
    "test": {
        "apiKey": "YOUR-TEST-USER-KEY"
    }
  }
}

Steamship employees can test against a server running on localhost by adding the following apiBase and appBase arguments to your test profile:

{
  "profiles": {
    "test": {
      "apiBase": "http://localhost:8080/api/v1/",
      "appBase": "http://localhost:8081",
      "apiKey": "CHANGEME"
    },
}

Testing Style

Many of the tests in this project are integration tests against a running, persistent version of Steamship, which means that care must be taken to destroy the resources created by a test.

That can be done using the client fixture, which yields a Steamship client anchored in a new workspace and then deletes the workspace and all of its resources after the test has been run.

To use it, write your tests like this:

from steamship.client import Steamship
from utils.fixtures import client # noqa: F401

def test_langchain_adapter(client: Steamship):
    # You can use the provided client to create resources, and those resources
    # will be cleaned up after completion
    pass