{"id":16375784,"url":"https://github.com/vankka/dependencydownload","last_synced_at":"2025-03-16T15:33:50.824Z","repository":{"id":43696009,"uuid":"375467944","full_name":"Vankka/DependencyDownload","owner":"Vankka","description":"A Java library (\u0026 Gradle plugin) to download dependencies during runtime with ease","archived":false,"fork":false,"pushed_at":"2024-07-27T13:02:23.000Z","size":346,"stargazers_count":29,"open_issues_count":6,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-11T03:22:10.744Z","etag":null,"topics":["dependency-management","gradle-plugin","java"],"latest_commit_sha":null,"homepage":"","language":"Java","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/Vankka.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"Vankka"}},"created_at":"2021-06-09T19:28:13.000Z","updated_at":"2024-08-06T00:54:15.000Z","dependencies_parsed_at":"2024-10-11T03:22:15.327Z","dependency_job_id":"4fcefc0a-9898-43fe-b448-5d46e457a1d1","html_url":"https://github.com/Vankka/DependencyDownload","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vankka%2FDependencyDownload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vankka%2FDependencyDownload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vankka%2FDependencyDownload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vankka%2FDependencyDownload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Vankka","download_url":"https://codeload.github.com/Vankka/DependencyDownload/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221665644,"owners_count":16860292,"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":["dependency-management","gradle-plugin","java"],"created_at":"2024-10-11T03:22:09.744Z","updated_at":"2024-10-27T10:52:34.924Z","avatar_url":"https://github.com/Vankka.png","language":"Java","funding_links":["https://github.com/sponsors/Vankka"],"categories":[],"sub_categories":[],"readme":"# DependencyDownload\n[![Maven Central](https://img.shields.io/maven-central/v/dev.vankka/dependencydownload-runtime?label=release)](https://central.sonatype.com/search?q=g%253Adev.vankka+dependencydownload)\n[![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/dev.vankka/dependencydownload-runtime?label=dev\u0026server=https%3A%2F%2Fs01.oss.sonatype.org)](https://s01.oss.sonatype.org/#view-repositories;snapshots~browsestorage~dev/vankka)\n[![Gradle Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/dev.vankka.dependencydownload.plugin?label=gradle%20plugin)](https://plugins.gradle.org/plugin/dev.vankka.dependencydownload.plugin)\n\nA library to download, relocate \u0026 load dependencies during runtime for Maven dependencies for JVM applications.\nThere is also a Gradle plugin to generate a metadata file, to avoid having to define the dependencies in code.\n\nUses [jar-relocator](https://github.com/lucko/jar-relocator/) for relocations during runtime  \nLooking for something to use with Minecraft? [Check out MinecraftDependencyDownload](https://github.com/Vankka/MinecraftDependencyDownload/)\n\n## Dependency\n\n## ⚠️ Group Id \u0026 Artifact Id change\n\nThe group id \u0026 artifact were changed in version `1.2.1` from `dev.vankka.dependencydownload:\u003cmodule\u003e` to `dev.vankka:dependencydownload-\u003cmodule\u003e`\n\n```groovy\nrepositories {\n    mavenCentral()\n}\n\ndependencies {\n    implementation 'dev.vankka:dependencydownload-runtime:1.3.1'\n}\n```\n\n\u003cdetails\u003e\n    \u003csummary\u003eSnapshots\u003c/summary\u003e\n\n```groovy\nrepositories {\n    maven {\n        url 'https://s01.oss.sonatype.org/content/repositories/snapshots/'\n    }\n}\n\ndependencies {\n    implementation 'dev.vankka:dependencydownload-runtime:1.3.2-SNAPSHOT'\n}\n```\n\u003c/details\u003e\n\n## Usage\n```java\n\nDependencyManager manager = new DependencyManager(DependencyPathProvider.directory(Paths.get(\"cache\")));\nmanager.addDependencies(new StandardDependency(\"com.example\", \"examplepackage\", \"1.0.0\", \"\u003chash\u003e\", \"SHA-256\"));\nmanager.addRelocations(new Relocation(\"com.example\", \"relocated.com.example\"));\n\nExecutor executor = Executors.newCachedThreadPool();\n\n// All of these return CompletableFuture it is important to let the previous step finishing before starting the next\nmanager.downloadAll(executor, Collections.singletonList(new StandardRepository(\"https://repo.example.com/maven2\"))).join();\nmanager.relocateAll(executor).join();\nmanager.loadAll(executor, classpathAppender).join(); // ClasspathAppender is a interface that you need to implement to append a Path to the classpath\n```\n\n## Gradle plugin\n```groovy\nplugins {\n    id 'dev.vankka.dependencydownload.plugin' version '1.3.1'\n}\n\ndependencies {\n    runtimeDownload 'some:dependency:x.y.z'\n    runtimeDownloadOnly 'some.other:dependency:x.y.z'\n}\n\njar.dependsOn generateRuntimeDownloadResourceForRuntimeDownloadOnly, generateRuntimeDownloadResourceForRuntimeDownload\n```\nThis would generate two files `runtimeDownloadOnly.txt` and `runtimeDownload.txt`\n\n### ShadowJar support\n[shadow](https://github.com/johnrengelman/shadow) is supported to include the relocations in the generated metadata files\n\n### Loading dependencies from a plugin generated file\n```java\nDependencyManager manager = new DependencyManager(DependencyPathProvider.directory(Paths.get(\"cache\")));\nmanager.loadResource(DependencyDownloadResource.parse(getClass().getResource(\"runtimeDownloadOnly.txt\")));\n```\n\n### Customizing \n```groovy\nimport dev.vankka.dependencydownload.task.GenerateDependencyDownloadResourceTask\n\ntask generateResource(type: GenerateDependencyDownloadResourceTask) {\n    configuration = project.configurations.runtimeDownload\n    includeRelocations = true\n    hashingAlgorithm = 'SHA-256'\n    file = 'dependencies.txt'\n}\n```\n\n## Download `jar-relocator` during runtime\nBring the jar minifying to the next extreme\n```groovy\nimport dev.vankka.dependencydownload.task.GenerateDependencyDownloadResourceTask\nplugins {\n    id 'dev.vankka.dependencydownload.plugin' version '1.3.1'\n}\n\nconfigurations {\n    jarRelocator\n}\n\nrepositories {\n    mavenCentral()\n}\n\ndependencies {\n    implementation('dev.vankka:dependencydownload-runtime:1.3.1') {\n        exclude module: 'jar-relocator'\n    }\n    jarRelocator 'me.lucko:jar-relocator:1.4'\n}\n\ntask generateJarRelocatorResource(type: GenerateDependencyDownloadResourceTask) {\n    configuration = project.configurations.jarRelocator\n}\nprocessResources.dependsOn generateJarRelocatorResource\n```\n\n```java\nDependencyManager manager = new DependencyManager(DependencyPathProvider.directory(Paths.get(\"cache\")));\nmanager.loadResource(DependencyDownloadResource.parse(getClass().getResource(\"jarRelocator.txt\")));\n\nExecutor executor = Executors.newCachedThreadPool(2);\n\nmanager.downloadAll(executor, Collections.singletonList(new StandardRepository(\"https://repo.example.com/maven2\"))).join();\nmanager.loadAll(executor, classpathAppender).join();\n// now jar-relocator is in the classpath and we can load (and relocate) dependencies from a regular configuration\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvankka%2Fdependencydownload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvankka%2Fdependencydownload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvankka%2Fdependencydownload/lists"}