Skip to main content
PyPi package

Features

  • List datasets

  • View dataset metadata

  • Create new datasets

Installation

This package requires Python3, i.e. it is not compatible with Python2.

pip install dtool-gui-tk

Usage

To start the application run the command:

dtool-tk

When the application starts for the first time the user will be asked to specify a directory to use as the “local base URI directory”. This is the location where the application will look for existing datasets and save new datasets to. The local base URI directory can be set and updated using the “Edit >> Edit preferences…” dialogue.

Existing datasets are displayed on the left hand side of the main window. Information about a selected dataset is available on the right hand side of the main window.

Main window of dtool-tk GUI

The main window of the dtool-tk GUI

When creating a new dataset one has to specify the name and the input directory from where the data files will be copied. One also needs to specify the metadata schema to use to describe the metadata.

Metadata schemas are described using a subset of the JSON schema syntax. The dtool-tk application comes with one basic schema built in:

{
  "type": "object",
  "properties": {
     "description": {"type": "string"}
  },
  "required": ["description"]
}

More metadata schemas can be added by creating approprate JSON files in the user’s ~/.config/dtool/metadata_schemas directory. Below is an example of a more complex metadata schema:

{
  "type": "object",
  "properties": {
     "description": {"type": "string", "minLength": 3, "maxLenth": 80},
     "age": {"type": "integer", "exclusiveMinimum": 0},
     "allowed": {"type": "boolean"},
     "celcius": {"type": "number", "exclusiveMinimum": -273.15},
     "continent": {
        "type": "string",
        "enum": [
          "Africa",
          "Antarctica",
          "Asia",
          "Europe",
          "North America",
          "South America"
        ]
     }
  },
  "required": ["description"]
}
New dataset window of dtool-tk GUI

The “New dataset” window of dtool-tk, using a more “complex” metadata schema. The optional metadata items “age” and “allowed” have been selected. Feedback is provided if the metadata entered does not conform to the specification in the schema as in the case of having an “age” less than or equal to 0.

Shortcuts

Description

Windows/Linux

Mac OSX

Create new dataset

Ctrl+N

Cmd+N

Edit metadata

Ctrl+M

Cmd+M

Edit tags

Ctrl+T

Cmd+T

Edit preferences

Ctrl+P

Cmd+,

Quit

Ctrl+Q

Cmd+Q

Metadata

Release files for dtool-gui-tk 0.4.0

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

Source distribution (sdist)

Source distribution for dtool-gui-tk 0.4.0
File Size Uploaded
dtool-gui-tk-0.4.0.tar.gz 213.2 kB Details

Release files / dtool-gui-tk-0.4.0.tar.gz

Download URL dtool-gui-tk-0.4.0.tar.gz
Size 213.2 kB
Tags Source
SHA-256 checksum
How to use checksums
eb423a9e74d671583a8da1bdb08338a2906a1c6187daca7b2c7ad133bebb47df
BLAKE2b-256 checksum
How to use checksums
1987fa498fe35af7e71d93c0c3942b28dd82d66a70b12506ba0bb4307a70bee8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.9

Release history Release notifications | RSS feed

This release

0.4.0 This release

1 release file

0.3.1

1 release file

0.3.0

1 release file

0.2.0

1 release file

0.1.1

1 release file

0.1.0

1 release file

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