Skip to main content

Dimcli

Dimcli is a Python client for accessing the Dimensions Analytics API. It makes it easier to authenticate against the API, send queries to it and process the JSON data being returned.

>>> import dimcli

>>> dimcli.login(key="private-key-here",  
                 endpoint="https://app.dimensions.ai/api/dsl/v2")
               
>>> dsl = dimcli.Dsl()

>>> res = dsl.query("""search grants for "malaria" return researchers""")

>>> print(res.json)
{'researchers': [{'id': 'ur.01332073522.49',
   'count': 75,
   'last_name': 'White',
   'first_name': 'Nicholas J'},
  {'id': 'ur.01343654360.43',
   'count': 59,
   'last_name': 'Marsh',
   'first_name': 'Kevin'},
  .............
  ],
 '_stats': {'total_count': 8735}}

CLI

Dimcli includes also a command line interface (CLI) that aims at simplifying the process of learning the grammar of the Dimensions Search Language (DSL).

dimcli_animation

Jupyter

Dimcli plays nice with Jupyter notebooks too. It comes with various magic commands for querying the API, transforming JSON data into dataframes and turning them into interactive tables with hyperlinks - so that data can be inspected further on external websites.

dimcli_animation_jupyter

More info

For more information see the Getting Started with Dimcli tutorial.

Current version: see pypi homepage. Source code hosted on github.

Downloads

Comments, bug reports

Dimcli lives on Github. You can file issues or pull requests there. Suggestions, pull requests and improvements welcome!

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dimcli-1.8.tar.gz (218.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dimcli-1.8-py2.py3-none-any.whl (252.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file dimcli-1.8.tar.gz.

File metadata

  • Download URL: dimcli-1.8.tar.gz
  • Upload date:
  • Size: 218.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.22

File hashes

Hashes for dimcli-1.8.tar.gz
Algorithm Hash digest
SHA256 c15fff460f5a0c12cefe12fb55fe9aa246c1258738e5028f1f049963a691bb21
MD5 37474ef55eec0f2d631f98c2d71cbb9e
BLAKE2b-256 8ee1910a6d6cc7b4cacb762c05ec798ce06d9fbb277f8c8dc50d8193b7c7b352

See more details on using hashes here.

File details

Details for the file dimcli-1.8-py2.py3-none-any.whl.

File metadata

  • Download URL: dimcli-1.8-py2.py3-none-any.whl
  • Upload date:
  • Size: 252.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.22

File hashes

Hashes for dimcli-1.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d1cdb13e737592e6fc7c35b822dc68217835c40a5e1e3a9c0ac882103c2672d8
MD5 1059526369036c5d7bf14350324387e1
BLAKE2b-256 4f296e345da74af99f39a35c1359e20a2e46c2a614e4bb9ffd00b73679b68a69

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.8

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page