st-text-annotator


Namest-text-annotator JSON
Version 0.3.4 PyPI version JSON
download
home_page
SummaryComponent for annotating text for NLP resolution
upload_time2023-12-07 10:52:44
maintainer
docs_urlNone
authorRobin Marquet
requires_python>=3.8, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*
licenseMIT
keywords streamlit text annotation nlp
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1> streamlit-annotation </h1>

- [Streamlit Text Annotator](#streamlit-text-annotator)
- [Demo](#demo)
- [Install](#install)
- [Quick Use](#quick-use)
- [Development](#development)
  - [Install](#install-1)
  - [Run](#run)
- [License](#license)
- [Author](#author)
- [Contributors](#contributors)

# Streamlit Text Annotator

[![PyPI version](https://badge.fury.io/py/st-text-annotator.svg)](https://badge.fury.io/py/st-text-annotator)
[![Downloads](https://pepy.tech/badge/st-text-annotator)](https://pepy.tech/project/st-text-annotator)
[![Downloads](https://pepy.tech/badge/st-text-annotator/month)](https://pepy.tech/project/st-text-annotator)
[![Downloads](https://pepy.tech/badge/st-text-annotator/week)](https://pepy.tech/project/st-text-annotator)

Streamlit Text Annotator is a Streamlit component that allows you to annotate text.

# Demo

[![Open in Streamlit](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://st-text-annotator.streamlit.app/)

![](docs/example.gif)

# Install

```
pip install st-text-annotator
```

# Quick Use

Create an example.py file

```python
from st_text_annotator import StTextAnnotator

text = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean et hendrerit orci. Praesent auctor malesuada lobortis. Suspendisse ac elit bibendum, congue tellus vel, ornare ipsum. Mauris at tellus in turpis aliquet cursus."

StTextAnnotator(text)
```

Run:

```
streamlit run example.py
```

Output:

```json
{
  "annotations": [
    [
      {
        "start": 0,
        "end": 5,
        "label": "Lorem"
      },
      {
        "start": 12,
        "end": 26,
        "label": "dolor sit amet"
      },
      {
        "start": 130,
        "end": 148,
        "label": "Curabitur lobortis"
      },
      {
        "start": 309,
        "end": 319,
        "label": "nec turpis"
      }
    ]
  ]
}
```

# Development

## Install

```
git clone git@github.com:rmarquet21/streamlit-text-annotator.git
cd streamlit-text-annotator
pip install -e .
```

## Run

```
streamlit run example.py
```

# License

MIT

# Author

Robin Marquet

# Contributors

- [Robin Marquet](robin.marquet3@gmail.com)


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "st-text-annotator",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*",
    "maintainer_email": "",
    "keywords": "streamlit,text,annotation,nlp",
    "author": "Robin Marquet",
    "author_email": "robin.marquet@epitech.eu",
    "download_url": "https://files.pythonhosted.org/packages/96/c5/025f66619a3ed090e7f1d71aa701f37582466e9c3399ed4715dc32c27810/st_text_annotator-0.3.4.tar.gz",
    "platform": null,
    "description": "<h1> streamlit-annotation </h1>\n\n- [Streamlit Text Annotator](#streamlit-text-annotator)\n- [Demo](#demo)\n- [Install](#install)\n- [Quick Use](#quick-use)\n- [Development](#development)\n  - [Install](#install-1)\n  - [Run](#run)\n- [License](#license)\n- [Author](#author)\n- [Contributors](#contributors)\n\n# Streamlit Text Annotator\n\n[![PyPI version](https://badge.fury.io/py/st-text-annotator.svg)](https://badge.fury.io/py/st-text-annotator)\n[![Downloads](https://pepy.tech/badge/st-text-annotator)](https://pepy.tech/project/st-text-annotator)\n[![Downloads](https://pepy.tech/badge/st-text-annotator/month)](https://pepy.tech/project/st-text-annotator)\n[![Downloads](https://pepy.tech/badge/st-text-annotator/week)](https://pepy.tech/project/st-text-annotator)\n\nStreamlit Text Annotator is a Streamlit component that allows you to annotate text.\n\n# Demo\n\n[![Open in Streamlit](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://st-text-annotator.streamlit.app/)\n\n![](docs/example.gif)\n\n# Install\n\n```\npip install st-text-annotator\n```\n\n# Quick Use\n\nCreate an example.py file\n\n```python\nfrom st_text_annotator import StTextAnnotator\n\ntext = \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean et hendrerit orci. Praesent auctor malesuada lobortis. Suspendisse ac elit bibendum, congue tellus vel, ornare ipsum. Mauris at tellus in turpis aliquet cursus.\"\n\nStTextAnnotator(text)\n```\n\nRun:\n\n```\nstreamlit run example.py\n```\n\nOutput:\n\n```json\n{\n  \"annotations\": [\n    [\n      {\n        \"start\": 0,\n        \"end\": 5,\n        \"label\": \"Lorem\"\n      },\n      {\n        \"start\": 12,\n        \"end\": 26,\n        \"label\": \"dolor sit amet\"\n      },\n      {\n        \"start\": 130,\n        \"end\": 148,\n        \"label\": \"Curabitur lobortis\"\n      },\n      {\n        \"start\": 309,\n        \"end\": 319,\n        \"label\": \"nec turpis\"\n      }\n    ]\n  ]\n}\n```\n\n# Development\n\n## Install\n\n```\ngit clone git@github.com:rmarquet21/streamlit-text-annotator.git\ncd streamlit-text-annotator\npip install -e .\n```\n\n## Run\n\n```\nstreamlit run example.py\n```\n\n# License\n\nMIT\n\n# Author\n\nRobin Marquet\n\n# Contributors\n\n- [Robin Marquet](robin.marquet3@gmail.com)\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Component for annotating text for NLP resolution",
    "version": "0.3.4",
    "project_urls": null,
    "split_keywords": [
        "streamlit",
        "text",
        "annotation",
        "nlp"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7483941f23e68833e79b1241c34d582b2143268db709cadbe9304f87012e3099",
                "md5": "b8478ab92302599f1f9b6d920fd0c6b6",
                "sha256": "1a0e46262b4e053e4395c609a574b4438f8369ea60cf0c96c19cb4685193e93a"
            },
            "downloads": -1,
            "filename": "st_text_annotator-0.3.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b8478ab92302599f1f9b6d920fd0c6b6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*",
            "size": 412456,
            "upload_time": "2023-12-07T10:52:42",
            "upload_time_iso_8601": "2023-12-07T10:52:42.957012Z",
            "url": "https://files.pythonhosted.org/packages/74/83/941f23e68833e79b1241c34d582b2143268db709cadbe9304f87012e3099/st_text_annotator-0.3.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "96c5025f66619a3ed090e7f1d71aa701f37582466e9c3399ed4715dc32c27810",
                "md5": "468bc514d93a5b8290866935ddb9078b",
                "sha256": "04ffa4df1cbe5a37f9a4f04fafbfa6817187335613059b31e2a7370dbeea2ec1"
            },
            "downloads": -1,
            "filename": "st_text_annotator-0.3.4.tar.gz",
            "has_sig": false,
            "md5_digest": "468bc514d93a5b8290866935ddb9078b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*",
            "size": 405498,
            "upload_time": "2023-12-07T10:52:44",
            "upload_time_iso_8601": "2023-12-07T10:52:44.816666Z",
            "url": "https://files.pythonhosted.org/packages/96/c5/025f66619a3ed090e7f1d71aa701f37582466e9c3399ed4715dc32c27810/st_text_annotator-0.3.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-07 10:52:44",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "st-text-annotator"
}
        
Elapsed time: 0.14848s