Welcome to Dataware Toolkit’s documentation!

Pydtk is a toolkit for managing, retrieving, and processing data.

Concepts

Pydtk are composed of three main components:

• DB handlers that manage the meta-information of data

• Models for reading/writing files of the right type

• IO function to select appropriate models based on meta-information and to read/write data

The relationship between the components are described in the following figure.

Installation

You can install the toolkit with the following command:

$ pip3 install git+https://github.com/dataware-tools/pydtk.git

If you want to install the toolkit with extra feature (e.g. support for mysql DB and ROS), you can install extra dependencies as follows:

$ pip3 install git+https://github.com/dataware-tools/pydtk.git#egg=pydtk[mysql,ros]

Quick start:

• 1. Try pydtk
  • 1.1. Example 1: Grab metadata from a database
  • 1.2. Example 2: Grab data based on metadata
• 2. Register an existing dataset

CLI:

• 1. Overview
• 2. DB Operations
  • 2.1. List databases
  • 2.2. List records
  • 2.3. List files
  • 2.4. List contents
  • 2.5. Get resources
  • 2.6. Add resources
  • 2.7. Delete resources
• 3. Model Operations
  • 3.1. List available models
  • 3.2. Test if a file can be read using PyDTK
  • 3.3. Generate a template of metadata
  • 3.4. Generate metadata from a file
• 4. IO Operations
  • 4.1. Read a file

API References:

• pydtk
  • pydtk package

Indices and tables

• Index

• Module Index

• Search Page