Metadata-Version: 2.1
Name: taguette
Version: 1.2.0
Summary: Document tagger for qualitative analysis
Home-page: https://www.taguette.org/
License: BSD-3-Clause
Keywords: qualitative,document,text,tagging,tags,highlights,notes
Author: Remi Rampin
Author-email: remi@rampin.org
Requires-Python: >=3.7,<4
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Text Processing
Provides-Extra: otel
Requires-Dist: SQLAlchemy (>=1.4,<1.5)
Requires-Dist: XlsxWriter (>=1.4,<1.5)
Requires-Dist: alembic (>=1.6,<1.8)
Requires-Dist: beautifulsoup4
Requires-Dist: bleach (>=3,<4)
Requires-Dist: html5lib (>=1,<2)
Requires-Dist: jinja2 (>=3,<3.1)
Requires-Dist: opentelemetry-api (>=1.5,<1.7)
Requires-Dist: opentelemetry-instrumentation-sqlalchemy (>=0.24b0,<0.26); extra == "otel"
Requires-Dist: opentelemetry-instrumentation-tornado (>=0.24b0,<0.26); extra == "otel"
Requires-Dist: prometheus-async
Requires-Dist: prometheus-client
Requires-Dist: redis (>=3,<4)
Requires-Dist: sentry-sdk
Requires-Dist: tornado (>=6.1)
Project-URL: Bug Tracker, https://gitlab.com/remram44/taguette/-/issues
Project-URL: Chat, https://app.element.io/#/room/#taguette:matrix.org
Project-URL: Documentation, https://www.taguette.org/getting-started.html
Project-URL: Open Collective, https://opencollective.com/taguette
Project-URL: Repository, https://gitlab.com/remram44/taguette
Project-URL: User Mailing List, https://groups.io/g/taguette
Description-Content-Type: text/x-rst

Taguette
========

A spin on the phrase "tag it!", `Taguette <https://www.taguette.org/>`__ is a free and open source qualitative research tool that allows users to:

+ Import PDFs, Word Docs (``.docx``), Text files (``.txt``), HTML, EPUB, MOBI, Open Documents (``.odt``), and Rich Text Files (``.rtf``).
+ Highlight words, sentences, or paragraphs and tag them with the codes *you* create.
+ (not yet) Group imported documents together (e.g. as 'Interview' or 'Lit Review').
+ Export tagged documents, highlights for a specific tag, a list of tags with description and colors, and whole projects.

`Check out our website to learn more about how to install and get started. <https://www.taguette.org/>`__

Motivation and goal
-------------------

Qualitative methods generate rich, detailed research materials that leave individuals’ perspectives intact  as well as provide multiple contexts for understanding phenomenon under study. Qualitative methods are used by a wide range of fields, such as anthropology, education, nursing, psychology, sociology, and marketing. Qualitative data has a similarly wide range: observations, interviews, documents, audiovisual materials, and more.

However - the software options for qualitative researchers are either **far too expensive**, don't allow for the seminal method of highlighting and tagging materials, *or actually perform quantitative analysis*, just on text.

**It's not right or fair that qualitative researchers without massive research funds cannot afford the basic software to do their research.**

So, to bolster a fair and equitable entry into qualitative methods, we've made Taguette!

Installation
------------

You can find complete installation instructions on `our website <https://www.taguette.org/install.html>`__, including installers for Windows and MacOS.

Development setup from the repository
-------------------------------------

You can 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 <https://swcarpentry.github.io/shell-novice/02-filedir/index.html>`__.
3. Taguette uses `Poetry <https://python-poetry.org/>`__ for its packaging and dependency management. You will need to `install Poetry <https://python-poetry.org/docs/#installation>`__.
4. Install Taguette and its dependencies by running ``poetry install``. Poetry will create a virtual environment for you by default, activate it by running ``poetry shell``.
5. Build translation files using ``scripts/update_translations.sh``.
6. You can start taguette in development mode using ``taguette --debug`` (or ``taguette --debug server <config_file>``). This will start Tornado in debug mode, which means in particular that it will auto-restart every time you make changes.
7. Navigate to `localhost:7465 <http://localhost:7465/>`__ to use Taguette!

License
-------

* Copyright (C) 2018, Rémi Rampin and Taguette contributors

Licensed under a **BSD 3-clause "New" or "Revised" License**. See the `LICENSE <LICENSE.txt>`__ for details.

