Skip to main content

Tags custom component for Streamlit

Project description

Streamlit-tags

pypi Version conda Version Downloads Conda downloads Streamlit App Documentation Status

streamlit-tags

A custom component to add Tags in Streamlit.

gif

📢 Favour:

It would be highly motivating, if you can STAR⭐ this repo if you find it helpful.

Try out a demo here: Streamlit App

Check out docs here: https://streamlit-tags.readthedocs.io/en/latest/

Install

PyPi

pip install streamlit-tags

The installation can also be found on PyPi

Anaconda

conda install -c gagan3012 streamlit-tags

The installation can also be found on Anaconda

Usage

This library has two main functions to display and use tags:

Definition

def st_tags(value: list,
            suggestions: list,
            label: str,
            text: str,
            maxtags: int,
            key=None) -> list:
    '''
    :param maxtags: Maximum number of tags allowed maxtags = -1 for unlimited entries
    :param suggestions: (List) List of possible suggestions (optional)
    :param label: (Str) Label of the Function
    :param text: (Str) Instructions for entry
    :param value: (List) Initial Value (optional)
    :param key: (Str)
        An optional string to use as the unique key for the widget.
        Assign a key so the component is not remount every time the script is rerun.
    :return: (List) Tags

    Note: usage also supports keywords = st_tags()
    '''

Note: the suggestion and value fields are optional

Note:

  • The suggestion and value fields are optional
  • Usage also supports keywords = st_tags()
  • Upgrade to 1.1.9 for being able to control number of tags

We also have a function now to embed the tags function to the sidebar:

def st_tags_sidebar(value: list,
                    suggestions: list,
                    label: str,
                    text: str,
                    maxtags: int,
                    key=None) -> list:
    '''
    :param maxtags: Maximum number of tags allowed maxtags = -1 for unlimited entries
    :param suggestions: (List) List of possible suggestions (optional)
    :param label: (Str) Label of the Function
    :param text: (Str) Instructions for entry
    :param value: (List) Initial Value (optional)
    :param key: (Str)
        An optional string to use as the unique key for the widget.
        Assign a key so the component is not remount every time the script is rerun.
    :return: Tags
    '''

Note:

  • The suggestion and value fields are optional
  • Usage also supports keywords = st_tags_sidebar()
  • Upgrade to 1.1.9 for being able to control number of tags

Example Usage

keywords = st_tags(
    label='# Enter Keywords:',
    text='Press enter to add more',
    value=['Zero', 'One', 'Two'],
    suggestions=['five', 'six', 'seven', 
                 'eight', 'nine', 'three', 
                 'eleven', 'ten', 'four'],
    maxtags = 4,
    key='1')

keyword = st_tags_sidebar(
    label='# Enter Keywords:',
    text='Press enter to add more',
    value=['Zero', 'One', 'Two'],
    suggestions=['five', 'six', 'seven', 
                 'eight', 'nine', 'three', 
                 'eleven', 'ten', 'four'],
    maxtags = 4,
    key='1')

Sample Images of the UI:

UI

We hit 10000 downloads!!

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

streamlit_tags-1.2.6.tar.gz (561.2 kB view details)

Uploaded Source

Built Distribution

streamlit_tags-1.2.6-py3-none-any.whl (2.7 MB view details)

Uploaded Python 3

File details

Details for the file streamlit_tags-1.2.6.tar.gz.

File metadata

  • Download URL: streamlit_tags-1.2.6.tar.gz
  • Upload date:
  • Size: 561.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0.post20210125 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.9

File hashes

Hashes for streamlit_tags-1.2.6.tar.gz
Algorithm Hash digest
SHA256 fe7ccd67dc6187feb09d830d170c6eedd7a765b9dfd5e037a83dc39e8eaeef03
MD5 e231a67ce522065af904e1c37adccf63
BLAKE2b-256 a4085813525a8aaca1ca17df8eabb8f8f3859f5dd4e904bb96e74fd3834ddaf7

See more details on using hashes here.

File details

Details for the file streamlit_tags-1.2.6-py3-none-any.whl.

File metadata

  • Download URL: streamlit_tags-1.2.6-py3-none-any.whl
  • Upload date:
  • Size: 2.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0.post20210125 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.9

File hashes

Hashes for streamlit_tags-1.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 f62326761590273c587d4a8a7673b8029f8ec3ca6bc1e67fcfd1bb07f358a2ad
MD5 ee6b4423c458836d7b70ab9a68b29805
BLAKE2b-256 6a57644d545ec968d42d9927adc042624a2b5d81f5e09cd1097c939a3ff5bd07

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