DSPL Tools
Stay organized with collections
Save and categorize content based on your preferences.
DSPL Tools is a small suite of command-line utilities
designed to help generate, organize, and validate DSPL datasets. The suite
currently includes the following components:
- DSPL Check:
Checks a dataset against a variety of criteria including
adherence to the official DSPL schema, consistency of internal references,
and CSV layout.
- DSPL Gen:
Generates a simple, DSPL dataset
"template" from an input CSV file
This software is released under a BSD license; the full source code is
available for
browsing and download
on GitHub. Release notes are provided in the DSPL Tools
README
file.
The section below describes how to install DSPL Tools. Once this is done,
you can run the individual utilities within the bundle. Follow the
links above for more information.
Note: The directions below and on the linked
subpages assume that you have a
basic familiarity with the command-line environment on your system
(e.g., you can get to the terminal / command-prompt, change
directories, express file paths, etc.).
Installing DSPL Tools
DSPL Tools is written in Python, a
cross-platform, open source scripting language. To set up, complete the
following steps:
- Install a Python interpreter (version 2.6 or 2.7), if required:
- Windows: Download and run the "Windows x86
MSI Installer" found on this page.
- Mac OS X: Python is installed by default, but you
may need to upgrade to a more recent version. See this page for details.
- Linux: Python is usually installed by default, but
you may need to upgrade to a more recent version. Consult the
documentation for your specific distribution.
- Install DSPL Tools:
- Download and extract the DSPL Tools zip bundle from the DSPL open source
site.
- Open a terminal / command-prompt window, navigate to the top-level
directory of the extracted zip file, and run:
python setup.py install
You may need to provide a full path to the Python executable; see step
3 below for details.
- (Optional) Extend your system path to include the Python
interpreter executable and the files
dsplcheck.py and
dsplgen.py.
- If this step is skipped, you may have to give full paths on these
components when running the tools, e.g. (on Windows)
c:\python27\python instead of just python.
- The instructions for doing this vary from machine to machine.
Consult your system documentation for guidance.
Some miscellaneous notes and caveats:
- DSPL Tools will not work with Python versions earlier than 2.6 or later
than 2.7.
- You may need to be logged in as an administrator on your machine to run
the steps above.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-06-26 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-06-26 UTC."],[[["\u003cp\u003eDSPL Tools is a command-line utility suite for generating, organizing, and validating DSPL datasets, including components like DSPL Check and DSPL Gen.\u003c/p\u003e\n"],["\u003cp\u003eThe tools are open-source, released under a BSD license, with source code and release notes available on GitHub.\u003c/p\u003e\n"],["\u003cp\u003eInstallation requires Python 2.6 or 2.7, downloading and extracting the DSPL Tools bundle, and running a setup command in the terminal.\u003c/p\u003e\n"],["\u003cp\u003eUsers may need to extend their system path to include the Python interpreter and DSPL Tools files for easier execution.\u003c/p\u003e\n"],["\u003cp\u003eDSPL Tools are compatible with Python versions 2.6 and 2.7 only and may require administrator privileges for installation.\u003c/p\u003e\n"]]],["DSPL Tools, a command-line utility suite, aids in creating, organizing, and validating DSPL datasets. Key components include DSPL Check for dataset validation against the DSPL schema and DSPL Gen for generating dataset templates from CSV files. Installation requires Python 2.6 or 2.7, downloading the DSPL Tools zip from the GitHub repository, and running `python setup.py install`. Users can optionally extend their system path to simplify command execution. The tools require a basic understanding of the command-line interface.\n"],null,["# DSPL Tools\n\n**DSPL Tools** is a small suite of command-line utilities\ndesigned to help generate, organize, and validate DSPL datasets. The suite\ncurrently includes the following components:\n\n- **[DSPL Check:](/public-data/docs/dsplcheck)** Checks a dataset against a variety of criteria including adherence to the official DSPL schema, consistency of internal references, and CSV layout.\n- **[DSPL Gen:](/public-data/docs/dsplgen)** Generates a simple, DSPL dataset \"template\" from an input CSV file\n\nThis software is released under a BSD license; the full source code is\navailable for\n[browsing and download](https://github.com/google/dspl)\non GitHub. Release notes are provided in the DSPL Tools\n[README\nfile](https://github.com/google/dspl/tree/master/tools/dspltools).\n\nThe section below describes how to install DSPL Tools. Once this is done,\nyou can run the individual utilities within the bundle. Follow the\nlinks above for more information.\n\n**Note:** The directions below and on the linked\nsubpages assume that you have a\nbasic familiarity with the command-line environment on your system\n(e.g., you can get to the terminal / command-prompt, change\ndirectories, express file paths, etc.).\n\nInstalling DSPL Tools\n---------------------\n\nDSPL Tools is written in [Python](http://www.python.org), a\ncross-platform, open source scripting language. To set up, complete the\nfollowing steps:\n\n1. Install a Python interpreter (version 2.6 or 2.7), if required:\n - **Windows:** Download and run the \"Windows x86 MSI Installer\" found on [this page](http://www.python.org/download/releases/2.7.1/).\n - **Mac OS X:** Python is installed by default, but you may need to upgrade to a more recent version. See [this page](http://www.python.org/download/mac/) for details.\n - **Linux:** Python is usually installed by default, but you may need to upgrade to a more recent version. Consult the documentation for your specific distribution.\n2. Install DSPL Tools:\n 1. Download and extract the DSPL Tools zip bundle from the [DSPL open source\n site](https://github.com/google/dspl/tree/master/tools/dspltools).\n 2. Open a terminal / command-prompt window, navigate to the top-level directory of the extracted zip file, and run: \n\n ```text\n python setup.py install\n ```\n You may need to provide a full path to the Python executable; see step 3 below for details.\n3. *(Optional)* Extend your system path to include the Python interpreter executable and the files `dsplcheck.py` and `dsplgen.py`.\n - If this step is skipped, you may have to give full paths on these components when running the tools, e.g. (on Windows) `c:\\python27\\python` instead of just `python`.\n - The instructions for doing this vary from machine to machine. Consult your system documentation for guidance.\n\nSome miscellaneous notes and caveats:\n\n- DSPL Tools will not work with Python versions earlier than 2.6 or later than 2.7.\n- You may need to be logged in as an administrator on your machine to run the steps above."]]