LogoLogo
HomeGitHub RepoBook Demo
version-4.1.x
version-4.1.x
  • Introduction
  • Installation
  • Quick start
  • Mental model
  • Architecture
  • Walkthrough
    • Editing a Package
    • Uploading a Package
    • Installing a Package
    • Getting Data from a Package
    • Working with the Catalog
    • Working with a Bucket
  • API Reference
    • quilt3
    • quilt3.Package
    • quilt3.Bucket
    • CLI, environment
    • Known limitations
  • Catalog
    • Admin UI
    • Configuration
    • Embed
    • Metadata for teams
    • Preview
    • Search & query
    • Visualization & dashboards
    • Local Development Mode
  • Examples
    • Git-like operations for datasets and Jupyter notebooks
  • Advanced
    • Filtering a Package
    • .quiltignore
    • Materialization
    • Working with Manifests
    • S3 Select
    • Workflows
    • Enterprise install
    • S3 Events, EventBridge
  • More
    • Frequently Asked Questions
    • Troubleshooting
    • Contributing
    • Changelog
Powered by GitBook
On this page
  • Python client
  • Developer
  • Web catalog and backend services (on AWS)

Was this helpful?

Installation

PreviousIntroductionNextQuick start

Last updated 3 years ago

Was this helpful?

Quilt has two user-facing components:

  • A Python client

  • A web catalog

Python client

Python 3.6 or higher is required.

$ pip install quilt3[pyarrow]

If you do not need to serialize and deserialize dataframes with Quilt, you can obtain a smaller install, useful in disk-constrained environments like AWS Lambda, with pip install quilt3.

If you plan to use , add catalog extra while installing quilt3, e.g.:

$ pip install quilt3[catalog,pyarrow]

If you wish to use AWS resources, such as S3 buckets, you will need valid AWS credentials. If this is your first time using the AWS CLI, run the following:

$ pip install awscli
$ aws configure

If you are already using the AWS CLI, you may use your existing profile, or .

Developer

Install the current Quilt client from master:

$ pip install git+https://github.com/quiltdata/quilt.git#subdirectory=api/python

Web catalog and backend services (on AWS)

See for installation instructions.

Quilt Catalog Local Development Mode
create a new profile
Enterprise install