{"id":14065530,"url":"https://github.com/iterative/example-repos-dev","last_synced_at":"2026-03-10T15:04:02.753Z","repository":{"id":37974872,"uuid":"159706789","full_name":"iterative/example-repos-dev","owner":"iterative","description":"Source code and generator scripts for example DVC projects","archived":false,"fork":false,"pushed_at":"2024-05-10T20:21:36.000Z","size":270,"stargazers_count":21,"open_issues_count":9,"forks_count":13,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-06-13T23:46:04.477Z","etag":null,"topics":["bash","dvc","example","machine-learning","open-source"],"latest_commit_sha":null,"homepage":"https://dvc.org/doc","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iterative.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-11-29T17:59:53.000Z","updated_at":"2024-05-10T20:21:40.000Z","dependencies_parsed_at":"2023-02-17T12:01:14.376Z","dependency_job_id":"cc4bf156-4b58-4318-b1c3-438cf44081d7","html_url":"https://github.com/iterative/example-repos-dev","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/iterative/example-repos-dev","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iterative%2Fexample-repos-dev","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iterative%2Fexample-repos-dev/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iterative%2Fexample-repos-dev/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iterative%2Fexample-repos-dev/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iterative","download_url":"https://codeload.github.com/iterative/example-repos-dev/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iterative%2Fexample-repos-dev/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260476262,"owners_count":23014999,"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":["bash","dvc","example","machine-learning","open-source"],"created_at":"2024-08-13T07:04:32.609Z","updated_at":"2026-03-10T15:03:57.714Z","avatar_url":"https://github.com/iterative.png","language":"Python","readme":"# Get Started Tutorial (sources)\n\nContains source code and [Shell](https://www.shellscript.sh/) scripts to\ngenerate and deploy example DVC repositories used in the [Get\nStarted](https://dvc.org/doc/get-started) and other sections of the DVC docs.\n\n## Requirements\n\nPlease make sure you have these available on the environment where these scripts\nwill run:\n\n- [Git](https://git-scm.com/)\n- [Python](https://www.python.org/) 3 (with `python3` and [pip](https://pypi.org/project/pip/) commands)\n- [Virtualenv](https://virtualenv.pypa.io/en/stable/)\n\n## Naming Convention for Example Repositories\n\nIn order to have a consistent naming scheme across all example repositories, the\nnew repositories should be named as:\n\n```\nexample-PROD-FEATURE\n```\n\nwhere `PROD` is one of the products like `dvc`, `cml`, `studio`, or `dvclive`, and `FEATURE` is\nthe feature that the repository focused on, like `experiments`, or `pipelines`.\nYou can also use additional keywords as suffix to differentiate from the others.\n\n⚠️ Please create all new repositories with the prefix `example-`.\n\n## Scripts\n\nEach example DVC project is in each of the root directories (below). `cd` into\nthe directory first before running the desired script, for example:\n\n```console\n$ cd example-get-started\n$ ./deploy.sh\n```\n\n### example-get-started\n\nThere are 2 GitHub Actions set up to test and deploy the project:\n\n- [test](.github/workflows/example-get-started-test.yaml)\n- [deploy](.github/workflows/example-get-started-deploy.yaml)\n\nThese will automatically test and deploy the project. If you need to run the project\nlocally/manually, you only directly need `generate.sh`. `deploy.sh` is a helper script\nrun within `generate.sh`.\n\n- `generate.sh`: Generates the `example-get-started` DVC project from\n  scratch. \n\n  By default, the source code archive is derived from the local workspace for\n  development purposes.\n\n  For deployment, use `generate.sh prod` to upload/download a source code\n  archive from S3 the same way as in [Connect Code and\n  Data](https://dvc.org/doc/get-started/connect-code-and-data).\n\n- `deploy.sh`: Makes and deploys code archive from\n  [example-get-started/code](example-get-started/code) to use for `generate.sh`.\n\n  By default, makes local code archive in example-get-started/code.zip.\n\n  For deployment, use `deploy.sh prod` to upload to S3.\n\n  \u003e Requires AWS CLI and write access to `s3://dvc-public/code/get-started/`.\n\n### example-get-started-experiments\n\nThere are 2 GitHub Actions set up to test and deploy the project:\n\n- [test](.github/workflows/example-get-started-experiments-test.yaml)\n- [deploy](.github/workflows/example-get-started-experiments-deploy.yaml)\n\nThese will automatically test and deploy the project. If you need to run the project locally/manually, run `generate.sh`.\n\nEven after automatic deployment, you still need to follow the\n[instructions](example-get-started-experiments/README.md) to:\n- Update Studio to create a PR from the best generated experiment.\n- Push to GitLab if you want to update the repo there.\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiterative%2Fexample-repos-dev","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiterative%2Fexample-repos-dev","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiterative%2Fexample-repos-dev/lists"}