Skip to main content

BRAT (brat rapid annotation tool) is based on the stav visualiser,

Project description

Brat package

Update and initialize submodules if cloning the repository

git submodule update --init --recursive

Installation from git

python3.8 -m venv venv

source venv/bin/activate

# python3.8 -m pip install .
python3.8 -m pip install git+https://github.com/melissayan/brat-package.git

# Confirm the executable is placed in the path
which brat

How to run brat

Create a test directory that will be used for annotation data:

mkdir -pv test
cd test

BRAT_PASSWORD=pass4 brat 8081

Environment Variables

Defaults:

BRAT_DATA_DIR=$(cwd)/annotation-data
BRAT_WORK_DIR=${HOME}/.brat
BRAT_USER=admin
BRAT_PASSWORD=
BRAT_AUTH_ENABLED='true'
BRAT_LOG_REQUESTS='true'
BRAT_MAX_SEARCH_RESULT_NUMBER=1000
BRAT_DEBUG='false'
BRAT_ADMIN_CONTACT_EMAIL='admin@example.com'
BRAT_HOST=''  # empty string means 0.0.0.0
BRAT_PORT=8081

All the variables can be overriden if set exporter before running brat.

If using BRAT_AUTH_ENABLED=true make sure to set BRAT_PASSWORD.

Example of disabling login:

BRAT_AUTH_ENABLED=false brat

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

bratserver-0.0.1.tar.gz (19.7 MB view details)

Uploaded Source

Built Distribution

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

bratserver-0.0.1-py3-none-any.whl (20.0 MB view details)

Uploaded Python 3

File details

Details for the file bratserver-0.0.1.tar.gz.

File metadata

  • Download URL: bratserver-0.0.1.tar.gz
  • Upload date:
  • Size: 19.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for bratserver-0.0.1.tar.gz
Algorithm Hash digest
SHA256 9e627fc280c5e46f266b4c0207614517715d2a5c0a003b592305fdde48a1ccc0
MD5 c77b4a1081dc01c89d85f09270e95e55
BLAKE2b-256 2ec2e17cce37bf0a08cdd39d0f21820cba484160ae2d238ba2e2fd8750f95524

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bratserver-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 20.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for bratserver-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5a296d705ba2b04d2abefb53ab40d295509c879c9be6510e164f4c433612b889
MD5 ef65b799528c91538f4d6d5f9173b4a1
BLAKE2b-256 3e79314ca04008678d2f39010b81aae38cb98e8fff15178ba4e7f58a06181feb

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