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-custom-componentt-0.0.2.tar.gz (103.7 kB view details)

Uploaded Source

Built Distribution

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

streamlit_custom_componentt-0.0.2-py3-none-any.whl (103.9 kB view details)

Uploaded Python 3

File details

Details for the file streamlit-custom-componentt-0.0.2.tar.gz.

File metadata

File hashes

Hashes for streamlit-custom-componentt-0.0.2.tar.gz
Algorithm Hash digest
SHA256 6c238f9caafc30ebd7e8449df4d9d3f83d71fdbe54295001bd1b7ac2cc6f004b
MD5 f45cca1fe0ac8f0cc96cd41b752217cf
BLAKE2b-256 e8edd223207488a2a899518b1c12cd7a6d8ef8f304b7a8d8a2775a859d5ce613

See more details on using hashes here.

File details

Details for the file streamlit_custom_componentt-0.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for streamlit_custom_componentt-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b0c7763a5041739a29d9270a8a03b753c507c37034510183ad0e230feceb90b7
MD5 16091e7566827e95e398ded32dc0f8b6
BLAKE2b-256 8e7a55d2cbfe177a3d52b7979e15daf2c6eb50869fc4f342ccf58ac47b3a87c8

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