Skip to main content

Blocks provides a simple interface to read, organize, and manipulate structured data in files on local and cloud storage

Project description


Blocks provides a simple interface to read, organize, and manipulate structured data in files on local and cloud storage. See the documentation for more information.

pip install sq-blocks




To install all dependencies for local development and testing, you can do

pip install -e .[dev]


  • pytest runs the unit tests

To run them locally:


Continuous Integrations

CI is handled through GitHub Actions, and will run non-GCS tests on 3.6, 3.7, 3.8. We may add cloud storage tests to CI soon, but for now tests should also be run locally to confirm that functionality works as well.

Versions and Tags

Use bumpversion to update the version of the package

bumpversion [major|minor|patch]

This will increment the version and update it both in and blocks/ It will also automatically commit a tag with the corresponding version. You can push this to the repo with

git push --tags


We use pre-commit to ensure consistent formatting, to make sure you run the hooks:

pre-commit install


The docs are generated from the code with sphinx, and can be tested locally:

cd docs
make html


Copyright 2018 Square, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sq-blocks-0.9.4.tar.gz (19.0 kB view hashes)

Uploaded source

Built Distribution

sq_blocks-0.9.4-py3-none-any.whl (22.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page