| Name | dvcartifacts JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | None |
| Summary | A simple CLI tool to download DVC artifacts from large monorepos |
| upload_time | 2024-07-09 09:26:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Copyright (c) 2018 The Python Packaging Authority Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
dvc
artifacts
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## Getting artifacts from monorepo projects without cloning the entire monorepo
`dvcartifacts` is a Python CLI tool which relies on `gitPython` and SSH to authenticate with a remote Git repository.
It uses sparse checkout without downloading anything outside of the specified project directory to speed up the cloning (cloning the project is required for getting the URL of the versioned artifact).
### Important notes/limitations
Artifacts are assumed to be created in specific project subdirectories in a monorepo with the following structure, i.e. with each DVC project initialized in a separate subdirectory.
```
monorepo
├── project_1
│ ├── .dvc
│ │ ├── config
│ │ └── .gitignore
│ ├── .dvcignore
│ ├── dvc.lock
│ ├── dvc.yaml
│ ├── mymodel.pkl
│ ├── my_script.py
│ └── requirements.txt
└── project_2
├── .dvc
│ ├── config
│ └── .gitignore
└── .dvcignore
```
It is also assumed that artifacts are registered by [GTO](https://dvc.org/doc/gto) using a naming convention `project_name:artifact_name`, for example `gto register project_1:mymodel`.
(This naming convention is automatically followed when artifacts are registered from the DVC Studio UI).
The tool relies on `boto3` or `google-cloud-storage` to access the bucket (depending on the cloud storage used as a remote).
Right now, only a DVC remote which is at the root of a bucket is supported properly (i.e. no subdirectories)
### Usage
```cli
usage: dvcartifacts [-h] [-r REV] repourl projectdir artifact_name
Download an artifact from the remote bucket
positional arguments:
repourl url of the GitHub repository associated with the artifact
projectdir project subdirectory in the monorepo where the artifact was created
artifact_name Name of the artifact to find
options:
-h, --help show this help message and exit
-r REV, --rev REV semantic version of the artifact (optional), latest version is used if this is not specified
```
Raw data
{
"_id": null,
"home_page": null,
"name": "dvcartifacts",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "dvc, artifacts",
"author": null,
"author_email": "Tibor Mach <tibor@iterative.ai>",
"download_url": "https://files.pythonhosted.org/packages/27/c8/d4333fe40049f3e3a91143581525607e38e5ca638c31120ba2904e87844a/dvcartifacts-0.0.2.tar.gz",
"platform": null,
"description": "## Getting artifacts from monorepo projects without cloning the entire monorepo\n\n`dvcartifacts` is a Python CLI tool which relies on `gitPython` and SSH to authenticate with a remote Git repository.\n\nIt uses sparse checkout without downloading anything outside of the specified project directory to speed up the cloning (cloning the project is required for getting the URL of the versioned artifact).\n\n### Important notes/limitations\n\nArtifacts are assumed to be created in specific project subdirectories in a monorepo with the following structure, i.e. with each DVC project initialized in a separate subdirectory.\n\n```\nmonorepo\n \u251c\u2500\u2500 project_1\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 .dvc\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 config\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 .gitignore\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 .dvcignore\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 dvc.lock\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 dvc.yaml\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 mymodel.pkl \n \u2502\u00a0\u00a0 \u251c\u2500\u2500 my_script.py\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 requirements.txt\n \u2514\u2500\u2500 project_2\n \u251c\u2500\u2500 .dvc\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 config\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 .gitignore\n \u2514\u2500\u2500 .dvcignore\n```\nIt is also assumed that artifacts are registered by [GTO](https://dvc.org/doc/gto) using a naming convention `project_name:artifact_name`, for example `gto register project_1:mymodel`.\n(This naming convention is automatically followed when artifacts are registered from the DVC Studio UI).\n\n\nThe tool relies on `boto3` or `google-cloud-storage` to access the bucket (depending on the cloud storage used as a remote).\n\nRight now, only a DVC remote which is at the root of a bucket is supported properly (i.e. no subdirectories)\n\n### Usage\n\n```cli\nusage: dvcartifacts [-h] [-r REV] repourl projectdir artifact_name\n\nDownload an artifact from the remote bucket\n\npositional arguments:\n repourl url of the GitHub repository associated with the artifact\n projectdir project subdirectory in the monorepo where the artifact was created\n artifact_name Name of the artifact to find\n\noptions:\n -h, --help show this help message and exit\n -r REV, --rev REV semantic version of the artifact (optional), latest version is used if this is not specified\n```\n",
"bugtrack_url": null,
"license": "Copyright (c) 2018 The Python Packaging Authority Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A simple CLI tool to download DVC artifacts from large monorepos",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/iterative/artifact-get-no-clone",
"Issues": "https://github.com/iterative/artifact-get-no-clone/issues"
},
"split_keywords": [
"dvc",
" artifacts"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "99999ed4b43d51c203aea124006f53a0ff3d49ed7855c739adc7a78e406dbee6",
"md5": "bd954cfb7cd5e263936752243d4eb563",
"sha256": "69a7abf5d23730c5e8acf91477a297ddc78bf254391d52a12465fbd3c554c0bd"
},
"downloads": -1,
"filename": "dvcartifacts-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bd954cfb7cd5e263936752243d4eb563",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 5616,
"upload_time": "2024-07-09T09:26:07",
"upload_time_iso_8601": "2024-07-09T09:26:07.935527Z",
"url": "https://files.pythonhosted.org/packages/99/99/9ed4b43d51c203aea124006f53a0ff3d49ed7855c739adc7a78e406dbee6/dvcartifacts-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "27c8d4333fe40049f3e3a91143581525607e38e5ca638c31120ba2904e87844a",
"md5": "aaa450cd97ee87d5c5d91a9f68e746b5",
"sha256": "90176cf6eeee6dc924d5c68b94507b8a0faa353be1b94c85400a863056b03469"
},
"downloads": -1,
"filename": "dvcartifacts-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "aaa450cd97ee87d5c5d91a9f68e746b5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 4532,
"upload_time": "2024-07-09T09:26:09",
"upload_time_iso_8601": "2024-07-09T09:26:09.654907Z",
"url": "https://files.pythonhosted.org/packages/27/c8/d4333fe40049f3e3a91143581525607e38e5ca638c31120ba2904e87844a/dvcartifacts-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-09 09:26:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "iterative",
"github_project": "artifact-get-no-clone",
"github_not_found": true,
"lcname": "dvcartifacts"
}
