LogoLogo
HomeGitHub RepoBook Demo
version-3.4.x
version-3.4.x
  • Introduction
  • Installation
  • Quick start
  • Mental model
  • Walkthrough
    • Editing a Package
    • Uploading a Package
    • Installing a Package
    • Getting Data from a Package
    • Working with the Catalog
    • Working with a Bucket
  • Advanced Usage
    • Filtering a Package
    • .quiltignore
    • Materialization
    • Working with Manifests
    • S3 Select
    • Workflows
    • Enterprise install
    • S3 Events, EventBridge
  • API Reference
    • quilt3
    • quilt3.Package
    • quilt3.Bucket
    • CLI, environment
  • More
    • Frequently Asked Questions
    • Troubleshooting
    • Contributing
    • Changelog
Powered by GitBook
On this page

Was this helpful?

  1. Advanced Usage

.quiltignore

PreviousFiltering a PackageNextMaterialization

Last updated 3 years ago

Was this helpful?

.quiltignore is a special file which, when included in a directory, can be used to filter out files that are included when you call quilt3.Package.set_dir from inside that directory:

$ ls
foo.txt         bar.txt         baz.txt
$ python -c "import quilt3; print(quilt3.Package().set_dir('/', './'))"
(local Package)
 └─foo.txt
 └─bar.txt
 └─baz.txt
$ echo foo.txt >> .quiltignore
$ ls -a
foo.txt         bar.txt         baz.txt
.quiltignore
$ python -c "import quilt3; print(quilt3.Package().set_dir('/', './'))"
(local Package)
 └─bar.txt
 └─baz.txt
 └─.quiltignore

This can be used to keep non-data files in the directory out of the data package. This is very useful when, for example, your data and your code live in the same directory.

The .quiltignore syntax is exactly the same as that of the familiar .gitignore. Refer to the for instructions on how to use it.

git documentation