Skip to main content

Uploading tagged data to Girder and Zotero using a GUI

Getting Started

Prerequisites

1. Install python3

Any python above 3.6 should be fine. Python 3.8 is recommended. You can install python3 from one of the following:

  • Download from the python official website here.
  • Install python3 using brew if you are using macOS brew install python@3.8
  • Install python3 using pyenv. See here.

NOTE

If you used pyenv to install Python on a Mac, tkinter might not be integrated by default. To install tkinter lib, you have to first uninstall your current python (if python is already installed), then reinstall it with:

PYTHON_CONFIGURE_OPTS="--with-tcltk-includes='-I/usr/local/opt/tcl-tk/include' --with-tcltk-libs='-L/usr/local/opt/tcl-tk/lib -ltcl8.6 -ltk8.6'" 
pyenv install {your python version}

2. Create Girder API key

A Girder API Key is needed in order to Login the Girder System.

  1. Login NutritionalLungImmunity. Create an account if you don't have one.
  2. Click your username on the top right -> MyAccount -> API Keys Tab -> Create new key. Keep this key private!

3. Create a Zotero API Key (optional)

If you want to attach Zotero Item with the tag list from Girder, a Zotero API Key is needed.

  1. Login Zotero. Go to account setting page.
  2. Click Create new private key.
  3. Under Personal Library, check all options. Under Default Group Permissions, select Read/Write. Then click Save key.
  4. Mark down the pop-up API key. Save it in a safe place.

Installation

  1. Install the virtual environment package

    python3 -m pip install virtualenv (on Windows add .exe to python3)

    If you have trouble with permission issues installing any packages system-wide, you may have more luck by installing them as user-local packages:

    python3 -m pip install --user virtualenv

  2. Create and move to a directory where you want to keep the virtual environment

    mkdir my-nlidatamanagement; cd my-nlidatamanagement

  3. Create a virtual environment

    virtualenv -p python3 venv (on Windows add .exe to virtualenv)

  4. Enter the virtual environment:

    . venv/bin/activate

    on Windows: .\venv\bin\activate.bat

  5. Install the uploader into the virtual environment

    python3 -m pip install nlidatamanagement

  6. Launching the uploader

    nli_data_management

Note: To re-launch the program, perform steps 4 and 6.

Note 2: The virtual environment is optional and serves to simplify potential package dependency problems. If you wish to install the uploader outside the virtual environment, only the last two steps are required. Re-launch is done via step 6.

To update the tool to a new version, enter the virtual environment and run

python3 -m pip install --upgrade nlidatamanagement

Initialize Connection

Connect to Girder

  1. Click Upload to Girder and a new setting window will pop up.
  2. Under Add new Girder instance:
    • Give the new Girder instance a name.
    • For Host, type data.nutritionallungimmunity.org
    • Copy and paste your Girder API Key in the API Key
  3. Click the add button
  4. Select the new added Girder instance and click Connect

Connect to Zotero

  1. Click Upload to Zotero
  2. Add a new Girder Instance, if you haven't done it yet.
  3. Under Add new zotero Instance:
    • Give the new Zotero instance a name.
    • For Library ID, type 2345225
    • For Library Type, type group
    • Copy and paste your Zotero API Key in the API Key
  4. Click the add button
  5. Select both Girder instance and Zotero instance. Click Connect

Metadata

Release files for nlidatamanagement 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nlidatamanagement 0.0.3
File Size Uploaded Provenance Actions
nlidatamanagement-0.0.3.tar.gz 50.9 kB Without provenance Details for nlidatamanagement-0.0.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for nlidatamanagement 0.0.3
File Interpreter ABI Platform Actions
nlidatamanagement-0.0.3-py3-none-any.whl Python 3 none any Details for nlidatamanagement-0.0.3-py3-none-any.whl

Total release size: 113.5 kB

Release files / nlidatamanagement-0.0.3.tar.gz

Download URL nlidatamanagement-0.0.3.tar.gz
Size 50.9 kB
Tags Source
SHA-256 checksum
How to use checksums
35774d23af82cf04b45f7a676b3c440cb1a9b65b13a8f193eadab9279caa3ac5
BLAKE2b-256 checksum
How to use checksums
ff721012232222aad4e3c53a9b6223dc652446e428edeb69f62a0676a49391cc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

Release files / nlidatamanagement-0.0.3-py3-none-any.whl

Download URL nlidatamanagement-0.0.3-py3-none-any.whl
Size 62.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1208acede876ce13837d5607a4cfced098fe6682e22f58ae5a6366044bbe2a0f
BLAKE2b-256 checksum
How to use checksums
a5c20d455773e76febaead3d9c7b026c5407cdbcae27d5b17233af1fda5244fd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

Security for nlidatamanagement 0.0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.3 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page