Skip to main content

Kairntech Sherpa building blocks for Streamlit apps

Project description

sherpa_streamlit

license tests codecov docs version PyPI - Python Version

Kairntech Sherpa building blocks for Streamlit apps

This package contains utilities for visualizing and building interactive Kairntech Sherpa-powered apps with Streamlit. It includes various building blocks you can use in your own Streamlit app, like visualizers for named entities, text classification, and more.

Installation

You can simply pip install sherpa-streamlit.

Quickstart

The package includes building blocks that call into Streamlit and set up all the required elements for you. You can either use the individual components directly and combine them with other elements in your app, or call the visualize function to embed the whole visualizer.

Put the following example code in a file.

# streamlit_app.py
import sherpa_streamlit

default_text = "Sundar Pichai is the CEO of Google."
sherpa_streamlit.visualize(default_text)

You can then run your app with streamlit run streamlit_app.py. The app should pop up in your web browser.

Developing

Pre-requesites

You will need to install flit (for building the package) and tox (for orchestrating testing and documentation building):

python3 -m pip install flit tox

Clone the repository:

git clone https://github.com/oterrier/sherpa_streamlit

Running the test suite

You can run the full test suite against all supported versions of Python (3.8) with:

tox

Building the documentation

You can build the HTML documentation with:

tox -e docs

The built documentation is available at `docs/_build/index.html.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sherpa-streamlit-0.1.4.tar.gz (127.0 kB view details)

Uploaded Source

Built Distribution

sherpa_streamlit-0.1.4-py3-none-any.whl (126.6 kB view details)

Uploaded Python 3

File details

Details for the file sherpa-streamlit-0.1.4.tar.gz.

File metadata

  • Download URL: sherpa-streamlit-0.1.4.tar.gz
  • Upload date:
  • Size: 127.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.25.1

File hashes

Hashes for sherpa-streamlit-0.1.4.tar.gz
Algorithm Hash digest
SHA256 7488027355a112b0b54b11a9a136a36c87fcee9df42e924c889205a6a2bf027b
MD5 5a6115e9b46969e394a01b4203aac6d1
BLAKE2b-256 20b16199bf44e438835b2104e8edd87cc2d87dff10d8ff48dae0d02564bb82d8

See more details on using hashes here.

File details

Details for the file sherpa_streamlit-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for sherpa_streamlit-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 641777bad881eff62503b4dac5679da3f436327906378cc13cf060cf2f477915
MD5 5467a9b3ddfb1119ab7f34096958b990
BLAKE2b-256 fdfb88c7ac49cef9d5ab71a053dba3705afceaff42524acec9c9ce121c4898c2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page