RSS michelepasin.org / code, music, words

Projects / all / DimCLI

DimCLI


DimCLI is an open-source Python client for accessing the Dimensions DSL, a domain specific language for research analysis and scientometrics studies. DimCLI makes it easier to learn the language, authenticate against the API, send queries to it and process the JSON data being returned.

The Dimensions DSL API provides full-text search and data retrieval for use in complex analyses and visualizations. The API uses an intuitive query language specifically developed for Dimensions data. You can retrieve, aggregate, and sort data from highly specific requests in a single API call. Additional services like text categorization are also available, allowing you to efficiently classify and interpret large datasets based on your unique requirements.

DimCLI Main features:

  • Autocomplete and support for writing Dimensions Search Language (DSL) queries
  • Python module and interactive REPL-style interface: calling dimcli from the terminal opens an interactive query console with syntax autocomplete, persistent history across sessions, pretty-printing and preview of JSON results, export to HTML and CSV, and more.
  • Handles authentication locally and globally on a single machine
  • Jupyter notebooks integration: Dimcli includes a number of features that simplify working with the Dimensions API within Jupyter notebooks e.g. maing commands, custom renderers etc..
  • Functionalities to export API results into dataframes and other data formats

Technology

  • Python and Click
  • prompt-toolkit for the interactive console
  • pandas for dataframe export
  • Sphinx for the documentation
Role
Design and development
Date
Mar 2019 – present
Links
https://github.com/lambdamusic/dimcli
DimCLI screenshot DimCLI screenshot