Metadata-Version: 2.1
Name: fairly
Version: 0.1.0a1
Summary: A package to create, publish, and download research datasets
Author-email: Serkan Girgin <s.girgin@utwente.nl>, Manuel Garcia Alvarez <m.g.garciaalvarez@tudelft.nl>, Jose Urra Llanusa <j.c.urrallanusa@tudelft.nl>
License: MIT License
        
        Copyright (c) 2022 JupyterFAIR Team
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/ITC-CRIB/fairly
Project-URL: Bug Tracker, https://github.com/ITC-CRIB/fairly/issues
Project-URL: Documentation, https://jupyterfair.readthedocs.io/en/latest/
Project-URL: Funding, https://nwo.nl/en/researchprogrammes/open-science/open-science-fund
Keywords: fairly,open science,research data,data management
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# Fairly
A package to create, publish and download research datasets.

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Installation

*Fairly* requires Python 3.8 or later, and it can be installed directly using PIP.

```shell
pip install fairly
```

### Installing from Source

1. Clone or download the [source code](https://github.com/ITC-CRIB/JupyterFAIR):
   
    ```shell
    git clone https://github.com/ITC-CRIB/fairly.git
    ```

2. Go to the root directory:
    ```shell
    cd fairly/
    ```

3. Compile and install using PIP:


    ```shell
    pip install .
    ```

## Usage

```python
import fairly
```

Currently, the package only supports the [Zenodo](https://zenodo.org/) and [4TU.ResearchDAata](https://data.4tu.nl/) repositories. For more details and examples, consult the [package documentation](https://jupyterfair.readthedocs.io/en/latest/package/installation.html).

## Contributions

Read the [guidelines](CONTRIBUTING.md) to know how you can be part of this open source project.

## Citation
Please cite this software using as follows:

*Grigin, S., Garcia Alvarez, M., & Urra Llanusa, J. Fairly [Computer software]*

## Acknowledgements

- [NWO Open Science Fund](https://www.nwo.nl/en/researchprogrammes/open-science/open-science-fund)
- [Digital Competence Centre, TU Delft](https://dcc.tudelft.nl/)
- [4TU.ResearchData](https://data.4tu.nl/)
