LogoLogo
HomeGitHub RepoBook Demo
dev
dev
  • About Quilt
  • Architecture
  • Mental Model
  • Metadata Management
  • Metadata Workflows
  • Quilt Platform (Catalog) User
    • About the Catalog
    • Bucket Browsing
    • Document Previews
    • Embeddable iFrames
    • Packaging Engine
    • Query
    • Quilt+ URIs
    • Qurator Omni
    • Search
    • Visualization & Dashboards
    • Advanced
      • Athena
      • Elasticsearch
      • Removing Stacks
  • Quilt Platform Administrator
    • Admin Settings UI
    • Catalog Configuration
    • Cross-Account Access
    • Enterprise Installs
    • quilt3.admin Python API
    • Advanced
      • Package Events
      • Private Endpoints
      • Restrict Access by Bucket Prefix
      • S3 Events via EventBridge
      • SSO Permissions Mapping
      • Tabulator
      • Troubleshooting
        • SSO Redirect Loop
    • Best Practices
      • GxP for Security & Compliance
      • Organizing S3 Buckets
  • Quilt Python SDK
    • Installation
    • Quick Start
    • Editing a Package
    • Uploading a Package
    • Installing a Package
    • Getting Data from a Package
    • Example: Git-like Operations
    • API Reference
      • quilt3
      • quilt3.Package
      • quilt3.Bucket
      • quilt3.hooks
      • Local Catalog
      • CLI, Environment
      • Known Limitations
      • Custom SSL Certificates
    • Advanced
      • Browsing Buckets
      • Filtering a Package
      • .quiltignore
      • Manipulating Manifests
      • Materialization
      • S3 Select
    • More
      • Changelog
      • Contributing
      • Frequently Asked Questions
      • Troubleshooting
  • Quilt Ecosystem Integrations
    • Benchling Packager
    • Event-Driven Packaging
    • Nextflow Plugin
Powered by GitBook
On this page

Was this helpful?

  1. Quilt Python SDK
  2. Advanced

.quiltignore

PreviousFiltering a PackageNextManipulating Manifests

Last updated 2 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