Skip to main content

Streamlit component that allows you to annotate PDFs

Project description

Streamlit PDF Annotator

Streamlit component that allows you to annotate PDFs easily, built with Vue3 and Vite.

Quickstart

Ensure you have Python 3.6+, Node.js and npm installed.

  1. Clone this repository:
git clone git@github.com:gabrieltempass/streamlit-component-vue-vite-template.git
  1. Go to the frontend directory and initialize and run the component template frontend:
cd streamlit-component-vue-vite-template/annotator/frontend
npm install
npm run dev
  1. From a separate terminal, go to the repository root directory, create a new Python virtual environment, activate it and install Streamlit and the template as an editable package:
cd streamlit-component-vue-vite-template
python3 -m venv venv
. venv/bin/activate
pip install streamlit
pip install -e .

Still from the same separate terminal, run the example Streamlit app:

streamlit run annotator/example.py

If all goes well, you should see something like this:

Quickstart Success

Modify the frontend code at annotator/frontend/src/MyComponent.vue. Modify the Python code at annotator/__init__.py.

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-pdf-annotator-0.0.1.tar.gz (103.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

streamlit_pdf_annotator-0.0.1-py3-none-any.whl (201.5 kB view details)

Uploaded Python 3

File details

Details for the file streamlit-pdf-annotator-0.0.1.tar.gz.

File metadata

  • Download URL: streamlit-pdf-annotator-0.0.1.tar.gz
  • Upload date:
  • Size: 103.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for streamlit-pdf-annotator-0.0.1.tar.gz
Algorithm Hash digest
SHA256 14a1a9aa70de0e3d54cffa53a2e43d0eb0c58c4a85200fac8ae2ae4132da5d60
MD5 fb01f3ee415f96e6286e057086f7182c
BLAKE2b-256 eed456445ae873fac6356d5bd0d56b430d5e526ea313bd268e7c897d20dd3231

See more details on using hashes here.

File details

Details for the file streamlit_pdf_annotator-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for streamlit_pdf_annotator-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 35998efcdba23d017cd27e520109fb26024c7601e85893c59829c4149005b686
MD5 23d2929847225f08a9af3787388d059a
BLAKE2b-256 3756635fbc06ec8959798397714591f1b400c0c10aba91cc2c7175185ef87cc5

See more details on using hashes here.

Supported by

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