Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 1.72 KB

DEVELOPING.md

File metadata and controls

60 lines (37 loc) · 1.72 KB
Raw

Developing

You can easily fork, customize, and republish this plugin with new functionality.

Change the Handle

Plugin handles are unique in Steamship. Think of them like you think of an NPM or Pip package name.

To customize and re-deploy this repository as your own, first edit the handle propery of steamship.json to create a new handle name.

Set up your Virtual Environment

We recommend using Python virtual environments for development. To set one up, run the following command from this directory:

python3 -m venv .venv

Activate your virtual environment by running:

source .venv/bin/activate

Your first time, install the required dependencies with:

python -m pip install -r requirements.dev.txt
python -m pip install -r requirements.txt

Develop

All the code for this plugin is located in the src/api.py file.

Steamship plugins conform to standard base classes -- you just have to implement the main function that represents their contract.

This project is a Blockifier plugin. It's contract is to take raw bytes and produce Steamship Blocks -- our internal format for describing text and tags over that text. In Python, that contract looks like:

    def run(self, request: PluginRequest[RawDataPluginInput]) -> Union[BlockAndTagPluginOutput]:
        pass

Throw, Log, and Test!

Your plugin code will be executing (1) remotely, (2) automatically, and (3) potentially at high-scale. This makes it critical that you:

  • Throw detailed exceptions eagerly
  • Log liberally
  • Write unit tests

See TESTING.md for details on the pre-configured testing setup.

Deploying

To run this plugin on Steamship, you must first deploy it.

See DEPLOYING.md for instructions.