{"id":14977344,"url":"https://github.com/digital-science/dimcli","last_synced_at":"2025-10-28T03:31:24.963Z","repository":{"id":41413253,"uuid":"133977840","full_name":"digital-science/dimcli","owner":"digital-science","description":"Python client and CLI for scientometrics and research analytics using the Dimensions API.","archived":false,"fork":false,"pushed_at":"2023-12-12T10:40:24.000Z","size":47430,"stargazers_count":43,"open_issues_count":19,"forks_count":6,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-04-29T23:00:02.679Z","etag":null,"topics":["api","cli","dimensions","jupyter-notebook","python","research-analytics","scientometrics"],"latest_commit_sha":null,"homepage":"https://digital-science.github.io/dimcli/getting-started.html","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/digital-science.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-18T16:16:51.000Z","updated_at":"2024-06-19T22:48:38.870Z","dependencies_parsed_at":"2022-09-07T06:13:57.033Z","dependency_job_id":"6949cd27-4000-4ec0-846c-1e93d5fc064a","html_url":"https://github.com/digital-science/dimcli","commit_stats":{"total_commits":605,"total_committers":14,"mean_commits":"43.214285714285715","dds":0.2479338842975206,"last_synced_commit":"66757f2c239151c3fd314b29251d1c049be3d4c2"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digital-science%2Fdimcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digital-science%2Fdimcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digital-science%2Fdimcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digital-science%2Fdimcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/digital-science","download_url":"https://codeload.github.com/digital-science/dimcli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238590593,"owners_count":19497351,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","cli","dimensions","jupyter-notebook","python","research-analytics","scientometrics"],"created_at":"2024-09-24T13:55:29.215Z","updated_at":"2025-10-28T03:31:19.917Z","avatar_url":"https://github.com/digital-science.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dimcli\n\nDimcli 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.  \n\n```bash\n\u003e\u003e\u003e import dimcli\n\n\u003e\u003e\u003e dimcli.login(key=\"private-key-here\",  \n                 endpoint=\"https://app.dimensions.ai/api/dsl/v2\")\n               \n\u003e\u003e\u003e dsl = dimcli.Dsl()\n\n\u003e\u003e\u003e res = dsl.query(\"\"\"search grants for \"malaria\" return researchers\"\"\")\n\n\u003e\u003e\u003e print(res.json)\n{'researchers': [{'id': 'ur.01332073522.49',\n   'count': 75,\n   'last_name': 'White',\n   'first_name': 'Nicholas J'},\n  {'id': 'ur.01343654360.43',\n   'count': 59,\n   'last_name': 'Marsh',\n   'first_name': 'Kevin'},\n  .............\n  ],\n '_stats': {'total_count': 8735}}\n\n```\n\n## CLI\n\nDimcli includes also a command line interface (CLI) that aims at simplifying the process of learning the grammar of the Dimensions Search Language (DSL).\n\n![dimcli_animation](https://raw.githubusercontent.com/digital-science/dimcli/master/static/dimcli_animated.gif)\n\n## Jupyter\n\nDimcli 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. \n\n![dimcli_animation_jupyter](https://raw.githubusercontent.com/digital-science/dimcli/master/static/dimcli_animated_jupyter.gif)\n\n## More info\n\nFor more information see the [Getting Started with Dimcli](https://digital-science.github.io/dimcli/getting-started.html) tutorial.\n\nCurrent version: see [pypi homepage](https://pypi.org/project/dimcli/). Source code hosted on [github](https://github.com/digital-science/dimcli). \n\n[![Downloads](https://pepy.tech/badge/dimcli)](https://pepy.tech/project/dimcli)\n\n\n## Comments, bug reports\n\nDimcli lives on [Github](https://github.com/digital-science/dimcli/). You can file [issues]([issues](https://github.com/digital-science/dimcli/issues/new)) or pull requests there. Suggestions, pull requests and improvements welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdigital-science%2Fdimcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdigital-science%2Fdimcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdigital-science%2Fdimcli/lists"}