This project addresses the problem of unreliable URLs by providing stable, long term storage for downloads. Instead of hoping that the upstream author (e.g. sourceforge or CPAN) will not remove or modify a downloadable .tar.gz file over time, you can rely on the Galaxy Cargo Port to maintain a copy of that file long term.
This helps package authors and tool developers work more efficiently, by allowing them to rely on URLs being permanently available.
Please make pull requests (PRs) adding new lines to the urls.tsv file with your package, the
expected sha256sum, and optionally a comment. If you don't need to make
sweeping changes to urls.tsv honestly your best choice for editing it is
probably going to be a spreadsheet tool like libreoffice. If you do need to
edit it in vim, I've found :set ts=120 to be helpful in aligning columns.
| Script Name | Script File | Args | Purpose |
|---|---|---|---|
galaxy-cachefile-dedup |
bin/dedup.py |
urls.tsv | Remove duplicate entries from urls.tsv |
galaxy-cachefile-validator |
bin/check.py |
urls.tsv | Verify the formatting of the urls.tsv file. Used by travis to ensure submissions are valid |
galaxy-cache-validator |
bin/verify.py |
urls.tsv [dryrun] | Verify the entire cargoport cache, to ensure that all sha256sums are valid and no packages have been downloaded incorrectly. |
galaxy-package-locator |
bin/gsl.py |
[--package_id PACKAGE_ID] [--package_version PACKAGE_VERSION] [--download_loaction DIR] | Download a package using the cargo port to the command line |
galaxy-package-tooldeps |
bin/expected.py |
urls.tsv id | Print the expected <action /> tags for use in Galaxy |
galaxy-package-updater |
bin/process_urls.py |
urls.tsv | Download all of the files listed in urls.ts |
The file consists of eight tab separated columns:
| Column | Name | Meaning |
|---|---|---|
| 1 | Id | A package ID, some short, unique (in the file) identifier for the package. |
| 2 | Version | A version number for the package. Should represent upstream's version accurately. |
| 3 | Platform | One of (linux, windows, darwin, src) |
| 4 | Architecture | One of (x32, x64, all) |
| 5 | Upstream URL | Upstream's URL for the download. This only necessarily exist before the Community Package Cacher downloads is the first time. After that the URL may disappear and we will retain our copy |
| 6 | Extension | File extension, used in downloads/nicer access for end-users |
| 7 | sha256sum | sha256sum of the correct file. |
| 8 | Use upstream | A boolean True or False on whether we should request upstream first, or use depot's download. Useful if upstream has requested that we stop making so many downloads to their old releases, or if the upstream URL is no longer available. |
You can use cargo-port with a small script called galaxy-package-locator.
Argument --package_id specifies the package name, --package_version the package version and with --download_location you can provide a path where the tarball should be stored.
Cargo port can be installed as follows:
$ git clone https://github.com/galaxyproject/cargo-port.git
$ cd cargo-port
$ python setup.py build
$ sudo python setup.py installDownloading a package with galaxy-package-locator can be done as follows:
galaxy-package-locator --package_id samtools --package_version "1.2"
The cargo port is available via rsync from rsync://depot.galaxyproject.org/software
If you are willing to mirror the cargo port, please go ahead and do so, and pull request this file with your URL.
MIT licensed. See LICENSE file.