{"id":37065032,"url":"https://github.com/c-3lab/dim-python","last_synced_at":"2026-01-14T07:36:29.495Z","repository":{"id":61034315,"uuid":"545406854","full_name":"c-3lab/dim-python","owner":"c-3lab","description":null,"archived":false,"fork":false,"pushed_at":"2023-05-27T05:13:27.000Z","size":63,"stargazers_count":0,"open_issues_count":12,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-09-21T09:16:18.638Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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/c-3lab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-10-04T10:07:27.000Z","updated_at":"2023-01-31T20:32:15.000Z","dependencies_parsed_at":"2023-02-03T20:01:39.934Z","dependency_job_id":null,"html_url":"https://github.com/c-3lab/dim-python","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/c-3lab/dim-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c-3lab%2Fdim-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c-3lab%2Fdim-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c-3lab%2Fdim-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c-3lab%2Fdim-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/c-3lab","download_url":"https://codeload.github.com/c-3lab/dim-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c-3lab%2Fdim-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28413439,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T05:26:33.345Z","status":"ssl_error","status_checked_at":"2026-01-14T05:21:57.251Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2026-01-14T07:36:29.068Z","updated_at":"2026-01-14T07:36:29.484Z","avatar_url":"https://github.com/c-3lab.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dim-python\n\n[![PyPI version](https://badge.fury.io/py/dim-python.svg)](https://badge.fury.io/py/dim-python)\n[![Downloads](https://static.pepy.tech/badge/dim-python)](https://pepy.tech/project/dim-python)\n\n\n\n`dim-python` is a Python implementation of [dim (Data Installation Manager): Manage open data in your projects, like a package manager](https://github.com/c-3lab/dim).\n\n## Join community\n\nWe are looking for members to develop together as an open source community.\n\n[Slack](https://join.slack.com/t/c3lab-hq/shared_invite/zt-v6zz66n9-1VYkVXC4zoQViWSMdzMTLg)\n\n## Quick Start\n\n1. Install the dim\n\nhttps://github.com/c-3lab/dim#install-the-dim\n\n2. Install the dim-python\n\n```\n$ pip install dim-python\n```\n\n3. Initialize the project for dim\n\n```\n$ dim init\n```\n\nAlso can initialize the project using dim-python.\n\n4. Use the dim-python\n\n```python\nimport dim\n\ndim.install('https://example.com/xxx.json', 'example_name', ['encode utf-8'])\n\nprint(dim.list())\n\nprint(dim.load_data('example_name', 'json'))\n\n```\n\n## Method\n\n* [load_data](#load_data)\n* [fetch_data](#fetch_data)\n* [load_dim_json](#load_dim_json)\n* [load_dim_lock_json](#load_dim_lock_json)\n* [init](#init)\n* [install](#install)\n* [uninstall](#uninstall)\n* [update](#update)\n* [list](#list)\n* [search](#search)\n\n### load_data\n\n```python\ndim.load_data('name', 'csv')\n```\n\n#### Parameters\n\n* name(requrire)\n  * Specify the data name\n* file_type(option)\n  * Specify 'text' or 'json' or 'csv'\n  * default: 'text'\n* dim_file_path(option)\n  * Specify a file path existing dim.json and dim-lock.json, data_files \n  * default: './'\n* encoding(option)\n  * Specify encoding of data\n  * default: 'utf-8'\n\n#### Return\n\nReturn type each file_type\n* text: str\n* csv : csv.DictReader object\n* json: dict\n\n---\n\n### fetch_data\n\n```python\ndim.fetch_data('name')\n```\n\n#### Parameters\n\n* name(requrire)\n  * Specify the data name\n* dim_file_path(option)\n  * Specify a file path existing dim.json and dim-lock.json, data_files \n  * default: './'\n\n#### Return\n\nrequests.Response object\n\n---\n\n### load_dim_json\n\n```python\ndim.load_dim_json()\n```\n\n\n#### Parameters\n\n* dim_file_path(option)\n  * Specify a file path existing dim.json and dim-lock.json, data_files \n  * default: './'\n* encoding(option)\n  * Specify encoding of data\n  * default: 'utf-8'\n\n#### Return\n\ndict\n\n---\n\n### load_dim_lock_json\n\n```python\ndim.load_dim_lock_json()\n```\n\n#### Parameters\n\n* dim_file_path(option)\n  * Specify a file path existing dim.json and dim-lock.json, data_files \n  * default: './'\n* encoding(option)\n  * Specify encoding of data\n  * default: 'utf-8'\n\n#### Return\n\ndict\n\n---\n\n### init\n\n```python\ndim.init()\n```\n\n#### Parameters\n\n#### Return\n\nboolean\n\n---\n\n### install\n\n```python\ndim.install()\n```\n\n#### Parameters\n\n* source(require)\n* name(require)\n* postprocesses(option)\n  * default: []\n* from_file(option)\n  * default: False\n* force(option)\n  * default: False\n* async_install(option)\n  * default: False\n\n#### Return\n\nboolean\n\n---\n\n### uninstall\n\n```python\ndim.uninstall('name')\n```\n\n#### Parameters\n* name(require)\n\n#### Return\n\nboolean\n\n---\n\n### update\n\n```python\ndim.update('name')\n```\n\n#### Parameters\n\n* name(require)\n* async_install(option)\n  * default: False\n\n#### Return\n\nboolean\n\n---\n\n### list\n\n```python\ndim.list()\n```\n\n#### Parameters\n\n* simple(option)\n  * default: False\n  \n#### Return\n\nstr\n\n---\n\n### search\n\n```python\ndim.search()\n```\n\n#### Parameters\n\n* keyword(require)\n* number(option)\n  * default: 10\n  \n#### Return\n\nstr\n\n---\n\n## Build\n\nInstall Python 3.8+.\n\nThen, install `poetry` 1.2.0+ as follows.\n\nWindows:\n\n```Bash\n# Linux, macOS, Windows (WSL)\ncurl -sSL https://install.python-poetry.org | python3 -\n# Windows (Powershell)\n(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -\n```\n\nInstall dependencies with `poetry`.\n\n```Bash\npoetry install\n```\n\n### Check version of dim\n\n```Python\nimport dim\ndim.__version__\n```\n\n## License\n\nRefer to [MIT License](https://github.com/c-3lab/dim-python/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fc-3lab%2Fdim-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fc-3lab%2Fdim-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fc-3lab%2Fdim-python/lists"}