<>div align="center">

Arabnotation is a text annotation tool for Arabic language. It provides annotation features for text classification, sequence labeling and sequence to sequence tasks. So, you can create labels and annotate your text easily.Just create a project, upload data and start annotating.

Read the documentation at the https://arabnotation.github.io/arabnotation/.

• Collaborative annotation
• Multi-language support
• Mobile support
• Emoji 😄 support
• Dark theme
• RESTful API

Three options to run arabnotation:

• pip (Python 3.8+)
• Docker
• Docker Compose

To install arabnotation, simply run:

pip install arabnotation

By default, SQLite 3 is used for the default database. If you want to use PostgreSQL, install the additional dependencies:

pip install 'arabnotation[postgresql]'

and set DATABASE_URL environment variable according to your PostgreSQL credentials:

DATABASE_URL="postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}?sslmode=disable"

After installation, run the following commands:

# Initialize database.
arabnotation init
# Create a super user.
doccano createuser --username admin --password pass
# Start a web server.
arabnotation webserver --port 8000

In another terminal, run the following command:

# Start the task queue to handle file upload/download.
arabnotation task

Go to http://127.0.0.1:8000/.

As a one-time setup, create a Docker container as follows:

docker pull doccano/arabnotation
docker container create --name arabnotation \
  -e "ADMIN_USERNAME=admin" \
  -e "ADMIN_EMAIL=admin@example.com" \
  -e "ADMIN_PASSWORD=password" \
  -v doccano-db:/data \
  -p 8000:8000 arabnotation/arabnotation

Next, start arabnotation by running the container:

docker container start arabnotation

Go to http://127.0.0.1:8000/.

To stop the container, run docker container stop arabnotation -t 5. All data created in the container will persist across restarts.

You need to install Git and to clone the repository:

git clone https://github.com/arabnotation/arabnotation.git
cd arabnotation

Note for Windows developers: Be sure to configure git to correctly handle line endings or you may encounter status code 127 errors while running the services in future steps. Running with the git config options below will ensure your git directory correctly handles line endings.

git clone https://github.com/arabnotation/arabnotation.git --config core.autocrlf=input

Then, create an .env file with variables in the following format (see ./docker/.env.example):

# platform settings
ADMIN_USERNAME=admin
ADMIN_PASSWORD=password
ADMIN_EMAIL=admin@example.com

# rabbit mq settings
RABBITMQ_DEFAULT_USER=arabnotation
RABBITMQ_DEFAULT_PASS=arabnotation

# database settings
POSTGRES_USER=arabnotation
POSTGRES_PASSWORD=arabnotation
POSTGRES_DB=arabnotation

After running the following command, access http://127.0.0.1/.

docker-compose -f docker/docker-compose.prod.yml --env-file .env up

Service	Button
AWS1
Wizardsudo

• How to create a user
• How to add a user to your project
• How to change the password

See the documentation for details.

As with any software, arabnotation is under continuous development. If you have requests for features, please file an issue describing your request. Also, if you want to see work towards a specific feature, feel free to contribute by working towards it. The standard procedure is to fork the repository, add a feature, fix a bug, then file a pull request that your changes are to be merged into the main repository and included in the next release.

Here are some tips might be helpful. How to Contribute to arabnotation Project

@misc{ArabNotation,
  title={{ArabNotation}: Text Annotation Tool for Arabic Language},
  url={https://ArabNotation/ArabNotation.com},
  note={Software available from https://ArabNotation/ArabNotation.com},
  author={
   -	Benlakehal Mohamed Younes.
-	Nedjmaoui Mahmoud.
},
  year={2022},
}

For help and feedback, please feel free to contact the author.