aat-downloader


Nameaat-downloader JSON
Version 0.0.4 PyPI version JSON
download
home_pagehttps://github.com/hgzech/aat_downloader/tree/master/
SummaryA downloader for mobile aat data.
upload_time2023-12-19 10:14:26
maintainer
docs_urlNone
authorHilmar Zech
requires_python>=3.6
licenseApache Software License 2.0
keywords mobile aat download downloader
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # AAT Downloader
> A package that helps download mobile AAT data.


## Install

`pip install aat_downloader`

## How to use

To use this package, first download the google-services.json file from the settings of your Firebase realtime database.

### Downloading data
To download data run the lines below (replace "experiment" with the experiment you want to delete).

```python
from aat_downloader.downloader import Downloader
# Initiate downloader with path to google services file (downloaded from Firebase)
downloader = Downloader("data/external/google-services.json")
```

    The autoreload extension is already loaded. To reload it, use:
      %reload_ext autoreload


```python
# Specify experiment name and storage folder and download data
downloader.download("experiment", "data/raw")
```

### Deleting data
To delete data run the following function (replace "experiment" with the experiment you want to delete).

```python
downloader.delete_participants("experiment")
```

    Warning: Are you sure you want to delete participants of experiment: fooddemo?
     y




            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/hgzech/aat_downloader/tree/master/",
    "name": "aat-downloader",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "mobile aat download downloader",
    "author": "Hilmar Zech",
    "author_email": "hgzech@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/69/04/31adecf018371752c5719f1534fcf0e5e0e34c86e403581dc0920dcaa5dc/aat_downloader-0.0.4.tar.gz",
    "platform": null,
    "description": "# AAT Downloader\n> A package that helps download mobile AAT data.\n\n\n## Install\n\n`pip install aat_downloader`\n\n## How to use\n\nTo use this package, first download the google-services.json file from the settings of your Firebase realtime database.\n\n### Downloading data\nTo download data run the lines below (replace \"experiment\" with the experiment you want to delete).\n\n```python\nfrom aat_downloader.downloader import Downloader\n# Initiate downloader with path to google services file (downloaded from Firebase)\ndownloader = Downloader(\"data/external/google-services.json\")\n```\n\n    The autoreload extension is already loaded. To reload it, use:\n      %reload_ext autoreload\n\n\n```python\n# Specify experiment name and storage folder and download data\ndownloader.download(\"experiment\", \"data/raw\")\n```\n\n### Deleting data\nTo delete data run the following function (replace \"experiment\" with the experiment you want to delete).\n\n```python\ndownloader.delete_participants(\"experiment\")\n```\n\n    Warning: Are you sure you want to delete participants of experiment: fooddemo?\n     y\n\n\n\n",
    "bugtrack_url": null,
    "license": "Apache Software License 2.0",
    "summary": "A downloader for mobile aat data.",
    "version": "0.0.4",
    "project_urls": {
        "Homepage": "https://github.com/hgzech/aat_downloader/tree/master/"
    },
    "split_keywords": [
        "mobile",
        "aat",
        "download",
        "downloader"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b73b5217ceb38e6c698440ff0b40102a07a1015ee76081f421bfa0d7adcf6dec",
                "md5": "0a89f3e4bbd1abd505c2d61528743e8f",
                "sha256": "4c56ff1e104a5ead3d4736d3e3412bf39080584f987dfee1d0566e5f0b37dbcb"
            },
            "downloads": -1,
            "filename": "aat_downloader-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0a89f3e4bbd1abd505c2d61528743e8f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 8032,
            "upload_time": "2023-12-19T10:14:24",
            "upload_time_iso_8601": "2023-12-19T10:14:24.449351Z",
            "url": "https://files.pythonhosted.org/packages/b7/3b/5217ceb38e6c698440ff0b40102a07a1015ee76081f421bfa0d7adcf6dec/aat_downloader-0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "690431adecf018371752c5719f1534fcf0e5e0e34c86e403581dc0920dcaa5dc",
                "md5": "9c66b90c01afb1acf857ea4dff7ae484",
                "sha256": "2b5a84c92724de8c23a71b77b44c0f984e109b6d4ea817447f0a652eb6318ada"
            },
            "downloads": -1,
            "filename": "aat_downloader-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "9c66b90c01afb1acf857ea4dff7ae484",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 10347,
            "upload_time": "2023-12-19T10:14:26",
            "upload_time_iso_8601": "2023-12-19T10:14:26.267670Z",
            "url": "https://files.pythonhosted.org/packages/69/04/31adecf018371752c5719f1534fcf0e5e0e34c86e403581dc0920dcaa5dc/aat_downloader-0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-19 10:14:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hgzech",
    "github_project": "aat_downloader",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "aat-downloader"
}
        
Elapsed time: 0.16062s