Uploading a Package
Once your package is ready it's time to save and distribute it.
To save a package to your local disk use
build
.import quilt3
p = quilt3.Package()
top_hash = p.build("aneesh/test_data")
Building a package requires providing it with a name. Packages names must follow the
"${namespace}/${packagename}"
format. For small teams, we recommend using the package author's name as the namespace.To share a package with others via a remote registry you will first need to authenticate against, if you haven't done so already:
# only need to run this once
# ie quilt3.config('https://your-catalog-homepage/')
quilt3.config('https://open.quiltdata.com/')
# follow the instructions to finish login
quilt3.login()
To share a package with others via a remote registry, use
push
:p = quilt3.Package()
p.push(
"aneesh/test_data",
"s3://quilt-example",
message="Updated version my package"
)
s3://quilt-example
is the registry—the storage backend that the package is available from.You can omit the registry argument if you configure a
default_remote_registry
(this setting persists between sessions):quilt3.config(default_remote_registry='s3://quilt-example')
p = quilt3.Package()
p.push("aneesh/test_data")
You can control where files land using
dest
:p = quilt3.Package()
p.push(
"aneesh/test_data",
dest="s3://quilt-example/foo/bar"
)
push
will send both a package manifest and its data to a remote registry. This will involve copying your data to S3. To save just the package manifest to S3 without any data copying, use build
:p = quilt3.Package()
p.build("aneesh/test_data", "s3://quilt-example")
This will create a new version of your package with all of its physical keys preserved.
To delete a package from a registry:
# delete a package in the local registry
quilt3.delete_package("aneesh/test_data")
# delete a package in a remote registry
quilt3.delete_package("aneesh/test_data", "s3://quilt-example")
Note that this will not delete any package data, only the package manifest.
Last modified 1yr ago