libreqda 1.2.0__tar.gz

libreqda-1.2.0/CHANGELOG.md

@@ -0,0 +1,481 @@
+LibreQDA Changelog
+==================
+
+1.2.0 (2026-09-10)
+------------------
+- New features:
+  - Reworked "Explore codes" with must/can/exclude zones
+  - Codebook image export (PNG, SVG)
+  - Downloads page (Windows installer, macOS .dmg, pip, Docker) + outdated-version banner on standalone bundles
+  - Push message system (in-app banners driven by a JSON file)
+  - Native bug report page (multi-screenshot, project selector, "All projects")
+- UX:
+  - Codebook compact layout persisted per project
+  - "Hide code count badges" preference in account settings
+- Bugfixes:
+  - Excluded tags dropped from overlap display; excluded-overlap highlights removed from Explore results
+  - Bold text no longer produces double underlines in extracts
+  - F5 restores Explore query summary from URL (including single-tag queries)
+  - Move code between zones in Explore instead of losing it
+  - Language kwargs duplicate crash on rendered pages
+
+1.1.4 (2026-07-13)
+------------------
+- Highlights count badge on document treeview (left of document name)
+- Auto-save collaborator changes (add, privileges, remove)
+- Bugfixes:
+  - Fix intro.js tutorial after V3 highlight refactor
+  - Fix polling events routing highlights to the wrong document
+
+1.1.3 (2026-05-20)
+------------------
+- Access rules, filter by IDP (entityid)
+- Bugfixes:
+  - Fix search in documents
+  - Fix navbar and header in documents when scrolling 
+
+1.1.2 (2026-04-28)
+------------------
+- Replace login flow with access rules
+
+1.1.1 (2026-04-15)
+------------------
+- Optimize highlight rendering performance
+- Update translations
+- Bugfixes:
+  - Fix NOT filter exclusion and badge rendering with operators
+  - Fix navbar scroll glitch and overflow
+  - Fix double underlines on multi-line highlights
+  - Fix AND operator to use spatial overlap
+  - Fix Dockerfile build and MySQL support for group_array
+  - Fix document search hiding uncategorized documents
+  - Fix archived project access
+- UI improvements:
+  - Overlapping tags clarity (dashed badges, hover to show)
+  - Project cards with pagination and search
+  - Archive/unarchive projects
+  - Compact layout toggle
+  - Text preview when clicking on existing codes
+  - Show real count in tooltip when badge displays 100+
+
+1.1.0 (2026-01-07)
+------------------
+- Document collections
+- Language selector on welcome page
+- Usage tips
+- Update translations
+- Update tests
+- SCSS refactoring
+- Allow theming (custom templates and CSS)
+- Allow to run on Unix socket (MR )
+- Bugfixes:
+  - Multiple display issues
+  - OAuth cookies
+  - Document deletion
+
+1.0.2 (2025-07-25)
+------------------
+- Update CILogon authentication template and make it responsive
+- Update translations
+
+1.0.1 (2025-06-16)
+------------------
+- OAuth authentication
+- Roles, some users need to be sponsored to create new projects. 
+  - ADMIN : Can do anything
+  - PROJECT_ADMIN : Can create projects and sponsor users
+  - TEAM_MEMBER : Can work in existing projects
+  - PROJECT_OWNER : Can create projects, cannot sponsor users
+- General UI/UX improvements
+  - Code hierarchy
+  - Code color
+  - Layered color bands
+  - Drag & drop codes
+  - Filter documents and codes
+  - Upload multiple documents
+  - Search in documents
+  - Complex queries to explore codes with (AND, OR, NOT)
+- General bug fixes
+- Code refactoring
+- Tests optimization
+
+0.9.0 (2024-04-03)
+------------------
+
+- Based on Taguette 1.4.1
+- Add an option to pass the authentication process to [CI Logon](https://www.cilogon.org/)
+
+Taguette Changelog
+==================
+
+1.4.1 (2023-02-04)
+------------------
+
+Bugfixes:
+* Fix highlighting in tables
+* Fix error adding documents in some situations due to a race condition (seems to only happen when using Redis)
+
+1.4.0 (2022-12-16)
+------------------
+
+Bugfixes:
+* Fix some validation on project import, filename mangling on document import
+* Relax filename requirements
+* When importing codebook, ignore case when looking at column names
+* Fix the resource usage when using Redis, and avoid dropping events in specific conditions
+* Fix the database warnings shown at startup
+* Fix language setting sometimes being out of sync between devices
+* Don't allow the creation of blank highlights (empty content, for example selecting a newline character)
+
+Enhancements:
+* Add Swedish translation
+* Add Indonesian translation
+* Add a script to validate the current database, useful if you have been using it across Taguette versions, or if you're writing to it programmatically
+* When adding a document, automatically change to it
+* Add `EXTRA_FOOTER` config setting to easily add information about a self-hosted instance
+* Enable SQLite's auto_vacuum mode on newly created databases
+* Update the password hashing method to scrypt, more secure
+* Perform password hashing and verification in background threads, to avoid locking up the application for everyone else
+* Prevent clickjacking attacks by serving the relevant headers, in case they are not already set by your reverse proxy
+* Add a script `register_user.py` to register a user even if registration is disabled
+* Allow more HTML tags in imported documents, like tables
+* Add a 'disabled' flag to users and a script to delete all user data (only keeping the 'login' in the database to prevent re-use)
+* Automatically select the new tag when creating a tag from the add/update highlight modal
+
+1.3.0 (2022-05-02)
+------------------
+
+Bugfixes:
+* Fix JavaScript error when trying to import a SQLite3 file with no projects in it
+* Fix `--database` option when not in server mode
+* Show a more meaningful error if importing an empty SQLite3 file, or a file that is not a SQLite3 database
+* Fix importing a codebook with duplicated tags
+* Fix importing a codebook with empty rows
+* Fix empty lines in log from conversion process
+
+Enhancements:
+* Add support for importing subtitle files (.srt or .vtt)
+* Strip leading and trailing whitespace from tag names in imported codebook
+* "Taguette Guide" opens in a new window
+* Add support for serving Taguette in a subdirectory (`BASE_PATH` setting)
+* Add health check endpoint (`/health`)
+* Internationalization improvements: add contexts, translate page titles
+* Add extras to install a database driver: `pip install taguette[postgres]` (or `mysql`)
+* Allow setting SQLAlchemy parameters from the config file, by making `DATABASE` a dictionary
+
+1.2.0 (2022-01-22)
+------------------
+
+Bugfixes:
+* Add some database indexes, improving performance on larger installations
+* Reload page when the server updates, avoiding clients on older versions if they never close the tab
+* Fix error importing SQLite3 file on Windows (and other permission errors on temporary files)
+* Show a helpful message if the imported codebook has rows that are too short, instead of 500 error
+* Fix a 403 error when importing a project if no other form has been shown before (single-user mode, no project created)
+
+Enhancements:
+* Focus the name (path) field when creating a tag
+* Add a keyboard shortcut to create a highlight: 'n' key (localizable)
+* Enable portable install in Windows installer (no admin access)
+
+1.1.1 (2021-10-17)
+------------------
+
+Bugfixes:
+* Don't cache documents forever in desktop mode (only server mode)
+
+1.1.0 (2021-10-12)
+------------------
+
+Bugfixes:
+* Avoid error "document name too long" if no name was provided and the filename is used
+* Don't deselect all tags from the highlight modal if it is open while creating a new tag
+* Avoid `TimeoutError` due to the SQLAlchemy connection pool overflowing (mostly affects busy self-hosted non-SQLite deployments)
+
+Enhancements:
+* Add support for right-to-left documents
+* Add importing tags from a codebook CSV file
+
+1.0.1 (2021-07-22)
+------------------
+
+This is a pip-only fix: binary installers, Docker, Poetry install are NOT affected.
+
+Bugfixes:
+* Fix incompatibility with SQLAlchemy 1.4
+
+1.0.0 (2021-07-17)
+------------------
+
+Bugfixes:
+* Fix highlights disappearing when one of their tags is deleted
+* Fix highlight modal showing "no tags" multiple times after removing the last tag repeatedly
+* Add missing title in exported highlights HTML
+
+Enhancements:
+* Allow disabling SQLite3 file import from the configuration file
+* Add option to use Redis to coordinate live collaboration if running Taguette in multiple processes
+
+0.11 (2021-07-06)
+-----------------
+
+Bugfixes:
+* Fix timezone issues on some SQL backends (PostgreSQL, not SQLite). Could cause recorded times to be wrong, and in some cases password reset links could be used multiple times
+* Fix the activity detection used to pause/resume polling
+* Fix default-config command outputing logs about umask, which could be piped into the new config file (for example when using Docker with `-t`)
+* Fix migrations on SQLite failing because of foreign key constraints when recreating tables
+* Fix RTF export
+* Fix retrying Calibre conversion with --enable-heuristics again
+* Fix Calibre leaving behind temporary files if it times out
+
+Enhancements:
+* Show more details when document export or import fails
+* Show the number of highlights per tag in exported codebooks
+* Performance improvement of getting a document or tag with many highlights
+* Add terms of service, which you can optionally set in your own instance
+* Made document/highlights/codebook exporting functions available under `taguette.export`, for use in scripts and notebooks
+* Improve button placement in the left panel (put "add a document" and "create a tag" at the top)
+* Add an HTML page for 404 errors
+* Improve error message when Calibre is not found
+* Add support for MariaDB (MySQL doesn't work because of error 1093, see https://stackoverflow.com/q/4429319)
+* Add option to import or export a project as a SQLite3 database
+* Allow a user to remove themselves from a project, without having to ask an admin
+
+0.10.1 (2021-02-22)
+-------------------
+
+Bugfixes:
+* Limit the number of page buttons
+* SQL query performance improvements
+* Force long document names to wrap (like long tag names)
+
+0.10 (2021-02-17)
+-----------------
+
+Bugfixes:
+* Check that tags exist in the project before adding them to highlights
+
+Enhancements:
+* SEO: Add page titles, robots.txt
+* Remind user of their login in the password reset email
+* Pause polling for changes when the window has been inactive for 10 minutes
+* Improve the error message shown when document import fails
+* Add pagination to the highlights view, which greatly improve performances for heavily used tags
+* Update to Tornado 6.1, remove workaround for older versions
+
+0.9.2 (2020-08-26)
+------------------
+
+Bugfixes:
+* Fix document conversion on Windows
+
+Enhancements:
+* Show spinner while loading document or tag view
+* Show the tag names next to each highlight in document export
+
+0.9.1 (2020-08-24)
+------------------
+
+Bugfixes:
+* Fix printed link not being flushed, causing it to be inaccessible e.g. running on Docker
+* Fix incompatibility with Python 3.8
+* Close DB connection during long polls, avoiding overflow of connection pool when using PostgreSQL
+* Don't allow a password reset link to be used more than once
+* Fix 'new highlight' button on Microsoft Edge
+* If Calibre fails, run it again without heuristics
+* Fix highlights being off in document export in non-ASCII paragraphs
+
+Enhancements:
+* Set umask to 077 by default (and add corresponding command-line options)
+* Restore Python 3.5 compatibility
+* Add a timeout to document conversion
+* Add Calibre output limits to the config
+* Fix some important messages being routed through log instead of direct to terminal
+
+0.9 (2019-11-23)
+----------------
+
+Bugfixes:
+* Fix showing highlights for a tag with a slash in it
+* Fix new tags showing NaN highlight count
+* Fix export button being on top of text, if the first line is long
+* Fix tag names containing '#' not working properly
+* Fix "new highlight" button showing at the top of the page when scrolling on Safari
+* Sort highlights in the exported highlights view as well
+* Fix merging tags that have common highlights (previous 500 error)
+
+Features:
+* Export codebook to Excel (.xlsx)
+* Show error details in alert messages (in English)
+* Highlight the currently selected tag(s) in the left panel
+* Don't show 403 if user can't change collaborators: show explanation, hide button
+* Add export of highlights to CSV and Excel (.xlsx) formats
+* Support PBKDF2 passwords (Taguette no longer requires 'bcrypt')
+
+0.8 (2019-06-15)
+----------------
+
+Bugfixes:
+* Don't show 500 error on invalid email reset token
+* Explicitly close DB connections, which might help with some warnings
+* Don't show 'merge' button in modal when creating a new tag
+* Fix getting logged out in single-user mode with `--debug`
+* Don't scroll to the top of the document when clicking on a disabled link
+* Fix taguette --database=filename not working when filename does not contain directories
+
+Features:
+* Add limits on converted file size
+* Don't have Calibre export image files from PDF, since we don't read them
+* Add a scrollbar to modals, since they can grow big in projects with many tags
+* Use the file name as document name if left blank
+* Show cookie warning before setting any (optional in configuration)
+* Add the REFI-QDA Codebook (.qdc) export format
+* Improve the collaborator management modal
+* Show the number of highlights which each tag in the "highlights" panel
+
+0.7 (2019-05-15)
+----------------
+
+Taguette can now be translated! You can help bring Taguette to your language on [Transifex](http://transifex.com/remram44/taguette/).
+
+Bugfixes:
+* Fix exporting highlights for non-ASCII tags
+* Fix account page not accepting empty optional fields
+* Fix document description being validated as its name
+* Fix importing documents with completely non-ASCII filenames
+
+Features:
+* Merge tags
+* Added internationalization
+* French translation
+* German translation
+* Spanish translation
+* Show tag names when hovering a highlight
+
+0.6 (2019-04-13)
+----------------
+
+Bugfixes:
+* Make 'display' headings responsive
+* Fix exported highlights being called "path"
+* Fix possible weird characters in exported documents on Windows (depending on locale)
+
+Features:
+* Convert logins to lower-case (login and collaborator forms will convert too, so it should only affect display). Users with non-lowercase logins will be logged out on update
+* Moved the `SECRET_KEY` to the config, no longer writing to `~/.cache`
+* Let you know when you have been logged out or removed from a project while working
+
+0.5 (2019-03-23)
+----------------
+
+Bugfixes:
+* Improve reading of OPF output from Calibre, which might fix compatibility with some combinations of Calibre versions and input formats
+* Long tag names no longer stick out of the left pane
+* Sort tags in highlight modal, documents in left pane, highlights and their tags in the highlights view
+
+Features:
+* Use a configuration file in server mode, rather than a growing list of command-line options
+* Expose metrics to Prometheus
+* Send errors to Sentry
+* Add 'delete project' button
+* Add account management page, to update email/password
+* Add password recovery feature (if you have an email set)
+* "New highlight" button shows up next to selected text rather than mouse, making it work with touch screens (mobile) and screen readers (hopefully)
+* Convert old .DOC files (Word 97) using WV if available
+* Add collaborator management modal, to add more members to a project
+* Changed default port number from `8000` to `7465`
+* Add spinning icon while requests are in progress, to prevent multiple submission of forms (document add takes ~10s for example)
+
+0.4.4 (2018-11-29)
+------------------
+
+Bugfixes:
+* Fix error creating a highlight when a paragraph is selected to the end
+* Correctly handle Calibre sometimes writing a `.xhtml` file instead of `.html`
+* Also show highlights with no tags when selecting "See all highlights"
+
+0.4.3 (2018-11-17)
+------------------
+
+Bugfixes:
+* Fix JavaScript error on a brand new project (no recorded Command)
+* Fix Commands being sent to the wrong project
+
+Features:
+* Add `--xheaders` option for the hosted setup, showing correct IPs in the log
+* Show which document in the list is the current one
+
+0.4.2 (2018-11-15)
+------------------
+
+Bugfixes:
+* Don't show highlights from a different document
+* Handle non-ascii text better
+* Fix real-time updates pausing if two changes happen in the same second
+* Add messages boxes to signal when something goes wrong
+* Sanitize name of uploaded files
+
+0.4.1 (2018-11-12)
+------------------
+
+Bugfixes:
+* Log errors from async handlers to the console instead of hiding them
+* Work around a problem computing highlight positions in documents when unicode is present (won't crash anymore, but positions might still be off, fix to come)
+* Fix not being able to create tags with names that collide with tags in other projects, and error creating a project if another project still uses default tags
+* Fix exporting a document that has 0 highlights
+* Fix document export missing highlights
+* Fix navbar expand button (shown on smaller screen sizes) not working
+
+0.4 (2018-11-11)
+----------------
+
+Bugfixes:
+* Make sure to hide auth token from URL bar
+* Fix tag description not showing up
+* Don't allow two tags to have the same name
+
+Features:
+* Add confirmation dialogs before deleting tags or documents
+* Create tag from the highlight window
+* New theme matching website (thanks to Vicky Steeves)
+* Add button to create a tag from the highlight modal
+* Show messages from taguette.fr, such as new version available
+* Add export options, allowing you to get your highlights or highlighted documents as HTML, DOCX, or PDF
+* Add HTML and PDF options for codebook export as well
+* Add an option to show (or export) all highlights, rather than only a specific tag
+
+0.3 (2018-10-29)
+----------------
+
+Bugfixes:
+* Fix having to reload for changes to appear when working on project other than 1.
+* Fix tags not being sorted by name
+
+Features:
+* Add 'backlight' mode, fading non-tagged text
+* Add modal dialog to edit and delete documents
+* Add migration system, to automatically upgrade the database to new schema version when required
+
+0.2 (2018-10-21)
+----------------
+
+Bugfixes:
+* Accept list and numbered lists, as generated from Markdown documents
+* Fix tag modal not able to add tags after a tag has been edited
+
+Features:
+* Add single-user mode, the default. Multi-user mode now needs `--multiuser`
+* Add login and registration pages
+* Add codebook export to CSV and DOCX files (contains list of tags with their descriptions)
+
+0.1 (2018-10-21)
+----------------
+
+First version, proof of concept. Not very useful, but showcases the app, and can be installed by alpha testers.
+
+* Can create projects
+* Can import documents into the database as HTML
+* Uses Calibre to convert supported documents into HTML
+* Can highlight parts of documents, and assign tags
+* Real-time notifications and collaboration
+* "Acceptable" UI with bootstrap

libreqda-1.2.0/LICENSE.txt

@@ -0,0 +1,28 @@
+Copyright (c) 2023, Plateforme en humanités numériques (Université de Sherbrooke) and contributors
+Copyright (c) 2018, Remi Rampin and Taguette contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

libreqda-1.2.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.1
+Name: libreqda
+Version: 1.2.0
+Summary: Free and open source qualitative research tool
+Home-page: https://www.libreqda.org/
+License: BSD-3-Clause
+Keywords: qualitative,document,text,tagging,tags,highlights,notes
+Author: Remi Rampin
+Author-email: remi@rampin.org
+Requires-Python: >=3.11,<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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Text Processing
+Provides-Extra: mysql
+Provides-Extra: otel
+Provides-Extra: postgres
+Requires-Dist: SQLAlchemy (>=1.4,<1.5)
+Requires-Dist: XlsxWriter (>=1.4,<4)
+Requires-Dist: alembic (>=1.6,<1.9)
+Requires-Dist: beautifulsoup4
+Requires-Dist: bleach (>=3,<6)
+Requires-Dist: chardet (>=4,<6)
+Requires-Dist: cryptography ; extra == "mysql"
+Requires-Dist: html5lib (>=1,<2)
+Requires-Dist: jinja2 (>=3.1,<3.2)
+Requires-Dist: libsass (==0.22.0)
+Requires-Dist: oauth2client (>=4.1.3,<5.0.0)
+Requires-Dist: opentelemetry-api (>=1.5,<1.11)
+Requires-Dist: opentelemetry-distro ; extra == "otel"
+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: psycopg2 (>=2.8,<3) ; extra == "postgres"
+Requires-Dist: pymysql (>=1.0,<2) ; extra == "mysql"
+Requires-Dist: redis (>=3,<5)
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: sentry-sdk
+Requires-Dist: setuptools (>=65,<81) ; python_version >= "3.11"
+Requires-Dist: subtitle-parser (>=1,<2)
+Requires-Dist: tornado (>=6.1)
+Project-URL: Bug Tracker, https://gitlab.com/bin-cirst/libreqda/libre-qda/-/issues
+Project-URL: Documentation, https://aide.libreqda.org
+Project-URL: Repository, https://gitlab.com/bin-cirst/libreqda/libre-qda
+Description-Content-Type: text/markdown
+
+
+_We are building on the work of [Taguette](https://www.taguette.org/) — go check them out! You will find close alignments between our code bases and even the installation instructions._
+
+
+LibreQDA
+========
+
+LibreQDA is developed by the [Plateforme en humanités numériques (PhuN)](https://www.usherbrooke.ca/flsh/recherche/centres-groupes-et-equipes-de-recherche/phun) at Université de Sherbrooke. 
+
+This qualitative data analysis software (QDA) allows you to:
+
++ Import PDFs, Word documents (`.docx`), text files (`.txt`), HTML, EPUB, MOBI, Open Documents (`.odt`), and Rich Text Files (`.rtf`).
++ Highlight words, sentences or paragraphs and tag them with codes you create.
++ Create hierarchical relations between your codes.
++ Retrieve your tagged documents and lists of encoded sentences.
++ Export you material in various formats for diffusion or post-processing with other tools.
+
+[Visit our website to consult the documentation.](https://help.libreqda.org/)
+
+Motivation and Goal
+-------------------
+
+Through its collaborations with research teams and non-profit organizations across various fields, the team at PHuN has come to recognize the crucial need for developing rich, resilient and responsive ecosystem of open-source QDA software. Numerous testimonies highlight the disconnect between the commercial incentives of proprietary software and the core theories of substantive qualitative analysis. Today, users of QDA are subjected to forced obsolescence, costly licenses, black box features and data restrictions that prevent them from fully owning their intellectual product.
+
+Our goal is to position LibreQDA as a valuable component within a diverse array of resources available to users seeking to develop a rich understanding of their textual data. We are committed to continuous improvement through community feedback and advocate for open integration with other tools to best meet your needs.
+
+If you think LibreQDA could do something better, reach out!
+
+Installation
+------------
+
+A secure instance of LibreQDA running on Canadian servers is available at [https://www.libreqda.org/](https://www.libreqda.org/). You can clone the software and run a single-user version on your computer using the instructions below. Installers for Windows and MacOS are pending.
+
+Docker
+------
+
+    docker pull phunudes/libreqda
+    docker run -d -p 7465:7465 -v libreqda-data:/data phunudes/libreqda
+
+Browse to [localhost:7465](http://localhost:7465/). Data persists in the `libreqda-data` volume.
+
+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. Taguette provide the base infrastructure for LibreQDA, which is reflected in these instructions:
+
+1. Clone this git repository from the terminal: `git clone https://gitlab.com/bin-cirst/libreqda/libre-qda/`
+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. LibreQDA 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 LibreQDA and its dependencies by running `poetry install`. Poetry will create a virtual environment for you by default, activate it by running `poetry shell`.
+   - To install dependencies for mysql or postgres, use the following command `poetry install -E postgres`. 
+5. Build translation files using `scripts/update_translations.sh`.
+6. You can start LibreQDA 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. 
+   1. A config file can be created by running `taguette default-config > taguette.conf`
+7. Navigate to [localhost:7465](http://localhost:7465/) to use LibreQDA!
+
+Create custom theme
+-------------------
+
+You can entirely configure LibreQDA interface by creating a theme.
+
+1. Run `poetry run make-theme [theme-name]`. That will create 2 folders :
+   - `taguette/static/scss/themes/[theme-name]` where the custom css are stored
+   - `taguette/templates/alt_templates/[theme-name]` where you can override templates with the same hierarchy as in the `templates` folder
+   - `taguette/static/alt_templates/[theme-name]` where you can put the files that you want to access in your custom template
+2. Add this line in `taguette.conf`: `THEME = "theme-name"`
+
+License
+-------
+* Copyright (c) 2023, Plateforme en humanités numériques (Université de Sherbrooke) and contributors
+* Copyright (c) 2018, Remi Rampin and Taguette contributors
+
+Licensed under a **BSD 3-clause "New" or "Revised" License**. See the `LICENSE.txt` file for details.
+