Metadata-Version: 2.4
Name: dcoraid
Version: 1.1.1
Summary: GUI/CLI for managing data on DCOR
Author: Paul Müller, Eoghan O'Connell, Raghava Alajangi
Maintainer-email: Paul Müller <dev@craban.de>
License-Expression: GPL-3.0-or-later
Project-URL: source, https://github.com/DCOR-dev/DCOR-Aid
Project-URL: tracker, https://github.com/DCOR-dev/DCOR-Aid/issues
Project-URL: documentation, https://dc.readthedocs.io
Project-URL: changelog, https://github.com/DCOR-dev/DCOR-Aid/blob/master/CHANGELOG
Keywords: RT-DC,DC,deformability,cytometry
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Science/Research
Requires-Python: <4,>=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: dclab[dcor]>=0.64.2
Requires-Dist: numpy>=1.21
Requires-Dist: requests>=2.31
Requires-Dist: urllib3>=2.0
Requires-Dist: requests_cache
Requires-Dist: requests_toolbelt>=1.0.0
Provides-Extra: gui
Requires-Dist: PyQt6; extra == "gui"
Dynamic: license-file

|DCOR-Aid|
==========

|PyPI Version| |Build Status| |Coverage Status|


DCOR-Aid is a GUI for managing data on DCOR (https://dc.readthedocs.io).


Installation
------------
Installers for Windows and macOS are available at the
`release page <https://github.com/DCOR-dev/DCOR-Aid/releases>`__.

If you have Python 3 installed, you can install DCOR-Aid with::

    pip install dcoraid[GUI]

After installation with pip, you can start DCOR-Aid with::

    python -m dcoraid

Testing
-------
By default, testing is done with https://dcor-dev.mpl.mpg.de and the user
"dcoraid". The API key must either be present in the environment variable
``DCOR_API_KEY`` or in the file ``tests/api_key``.

::

    pip install -e .[GUI]
    pip install pytest pytest-qt
    pytest tests


.. |DCOR-Aid| image:: https://raw.github.com/DCOR-dev/DCOR-Aid/main/dcoraid/img/splash.png
.. |PyPI Version| image:: https://img.shields.io/pypi/v/dcoraid.svg
   :target: https://pypi.python.org/pypi/DCOR-Aid
.. |Build Status| image:: https://img.shields.io/github/actions/workflow/status/DCOR-dev/DCOR-Aid/check.yml
   :target: https://github.com/DCOR-dev/DCOR-Aid/actions?query=workflow%3AChecks
.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/DCOR-dev/DCOR-Aid/main.svg
   :target: https://codecov.io/gh/DCOR-dev/DCOR-Aid
