Metadata-Version: 2.1
Name: research-client
Version: 0.4.2
Summary: An app that aims to make life easier for researchers working on bilingualism, sociolinguistics, language attitudes, and regional/minority/minoritized languages.
Home-page: https://github.com/lart-bangor/lart-research-client
Author: Florian Breit, Marco Tamburelli
Author-email: f.breit@bangor.ac.uk
License: AGPLv3-or-later OR EUPL-1.2+
Project-URL: Documentation, https://research-client.readthedocs.io/
Project-URL: Bug Tracker, https://github.com/lart-bangor/research-client/issues
Project-URL: Support, https://github.com/lart-bangor/research-client/discussions
Project-URL: Source, https://github.com/lart-bangor/research-client
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
Classifier: Natural Language :: English
Classifier: Natural Language :: German
Classifier: Natural Language :: Italian
Classifier: Natural Language :: Greek
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: Microsoft :: Windows :: Windows 11
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: JavaScript
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Sociology
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Topic :: Utilities
Requires-Python: >=3.10
License-File: LICENSE
License-File: LICENSE.AGPL-3.0
License-File: LICENSE.EUPL-1.2
Requires-Dist: greenlet (<2.0.0)
Requires-Dist: gevent (<22.10.0)
Requires-Dist: eel[jinja2] (==0.16.0)
Requires-Dist: platformdirs (==3.2.0)

|appicon| The L’ART Research Client
===================================

The L’ART Research Client is a freely available open-source app
that aids researchers in the collection, storage and transfer of
data for research in bilingualism and language attitudes, especially
in cases of bilinguals who speak a majority language and a regional
/ minority / minoritized language.


* 📥 `Download <https://github.com/lart-bangor/research-client/releases>`_
* 🧭 `User Guide <https://research-client.readthedocs.io/en/latest/users/index.html>`_
* 📜 `Quick Tutorials <https://research-client.readthedocs.io/en/latest/tutorials/index.html>`_
* 🛟 `Support <https://github.com/lart-bangor/research-client/discussions>`_


Features
--------

* **Fieldwork-ready** — use the included versions of the LSBQe, AToL, MGT, and digital informed consent forms, or make your own versions.
* **Reproducible** — make your research reproducible by simply sharing version information.
* **Extensible** — contribute with JSON, Python, HTML and JavaScript or import the backend in your own Python project.
* **Free and open** — dual-licensed under the `AGPLv3-or-later <https://www.gnu.org/licenses/agpl-3.0.en.html>`_ and the `EUPL-1.2+ <https://commission.europa.eu/content/european-union-public-licence_en>`_.
* **Cross-platform** — runs on Windows, Linux, and MacOS.

Screenshot
----------

.. image:: https://repository-images.githubusercontent.com/458875402/562a6dea-f501-4086-a192-63ab34d5823d

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

Installation on Windows is super simple:
Go to the `Releases <https://github.com/lart-bangor/research-client/releases>` and download the
Windows installer for the latest version (or an earlier one if you need that).
Run it and follow the instructions.

For a detailed walk-through, and instructions for Linux and MacOS, see our
`Installation Guide <https://research-client.readthedocs.io/en/latest/users/installation.html>`_.

Documentation
-------------

Comprehensive documentation for the L’ART Research Client, including a User Guide, Quick Tutorials,
a Developer Guide and an API Reference for both the backend and frontend are available from the
`official documentation hosted on Read the Docs <https://research-client.readthedocs.io>`_.

Contributing
------------

Development of the L’ART Research Client is a collaborative effort which we hope will benefit many
researchers in our field. Your contributions are actively welcome. Please see the
`Contributing <https://research-client.readthedocs.io/en/latest/developers/contributing.html>`_
section of our `Developer Guide <https://research-client.readthedocs.io/en/latest/developers/index.html>`_
for all you need to know to get going.

Citing
------

If you use the L’ART Research Client (or parts of it), please cite the following document or directly
import the project's
`citation metadata <https://raw.githubusercontent.com/lart-bangor/research-client/main/CITATION.cff>`_
into your reference manager.

   Breit, F., Tamburelli, M., Gruffydd, I. and Brasca, L. (2022). The L’ART Research Client app: A digital toolkit for bilingualism and language attitude research [Software, version 0.3.6]. Bangor University.


Questions, issues, ...
----------------------

For any questions not answered by the documentation, or anything you wish to disucss that's to do with
the app, use the `GitHub Discussions <https://github.com/lart-bangor/research-client/discussions>`_ feature.

To report issues/bugs, please use  `GitHub Issues <https://github.com/lart-bangor/research-client/discussions>`_.

.. |appicon| image:: https://raw.githubusercontent.com/lart-bangor/research-client/main/research_client/web/img/appicon.png
   :height: 26
   :align: bottom
