Install TAGUETTE

Taguette is released under the BSD-3-Clause license. You can read about the team behind Taguette on our About page.

Installers

Installers are available from MacOS and Windows from our latest release page. Those include Python, Taguette, and Calibre, so you don't need to install anything else. A "Taguette" entry should appear in your list of applications (Start Menu on Windows, or Launchpad/Spotlight on MacOS).

Once you start the application, you will see a terminal window appear. This is normal! You can ignore it completely and use Taguette from your web browser (localhost:8000 should open automatically). Simply leave the terminal window open until you are done using Taguette, after which you can close that terminal window to stop Taguette.

Installation using pip

You first need to install Python 3 and Calibre, the open source e-book management software. Taguette uses a part of Calibre to convert documents into HTML, allowing you to highlight and tag parts of them.

Once you've installed Python, you can install Taguette with its dependencies from the command line with the following:

pip install taguette

After which you can simply run taguette in the terminal to get it going. You'll see the command line will still be running. This is ok! Don't worry about the terminal, but do leave it running. A browser window should appear, pointing you to localhost:8000, and you can begin working on your projects!

Development set-up

You can also install from a local clone of this repository, which will allow you to easily change the sources to suit your needs:

  1. Clone this git repository from the terminal: git clone https://gitlab.com/remram44/taguette.git
  2. Navigate on the command line to the repository you've just cloned locally, using the cd command. To get help using cd, use this tutorial.
  3. To install the dependencies of Taguette, run pip install -e . We recommend you run this inside of a virtualenv or pipenv if possible.
  4. You can start taguette in development mode using python -m taguette.main --debug. This will start Tornado in debug mode, which means in particular that it will auto-restart every time you make changes.
  5. Navigate to localhost:8000 to use Taguette!

Learn about using Taguette at our getting started page!