Skip to main content

Fast read/write of AVRO files

Project description

# fastavro [![Build Status](https://travis-ci.org/tebeka/fastavro.svg?branch=master)](https://travis-ci.org/tebeka/fastavro) [![Documentation Status](https://readthedocs.org/projects/fastavro/badge/?version=latest)](http://fastavro.readthedocs.io/en/latest/?badge=latest)

Because the Apache Python avro package is written in pure Python, it is relatively slow. In one test case, it takes about 14 seconds to iterate through a file of 10,000 records. By comparison, the JAVA avro SDK reads the same file in 1.9 seconds.

The fastavro library was written to offer performance comparable to the Java library. With regular CPython, fastavro uses C extensions which allow it to iterate the same 10,000 record file in 1.7 seconds. With PyPy, this drops to 1.5 seconds (to be fair, the JAVA benchmark is doing some extra JSON encoding/decoding).

fastavro supports the following Python versions:

  • Python 2.7
  • Python 3.4
  • Python 3.5
  • Python 3.6
  • PyPy
  • PyPy3

[Cython]: http://cython.org/

# Documentation

Documentation is available at http://fastavro.readthedocs.io/en/latest/

# Installing fastavro is available both on [PyPi](http://pypi.python.org/pypi)

pip install fastavro

and on [conda-forge](https://conda-forge.github.io) conda channel.

conda install -c conda-forge fastavro

# Contributing

  • Bugs and new feature requests typically start as github issues where they can be discussed. I try to resolve these as time affords, but PRs are welcome from all.
  • Get approval from discussing on the github issue before opening the pull request
  • Tests must be passing for pull request to be considered

# Hacking

As recommended by Cython, the C files output is distributed. This has the advantage that the end user does not need to have Cython installed. However it means that every time you change fastavro you need to run make.

### Releasing

We release both to [pypi][pypi] and to [conda-forge][conda-forge].

We assume you have [twine][twine] installed and that you’ve created your own fork of [fastavro-feedstock][feedstock].

  • Make sure the tests pass
  • Run make tag
  • Copy the windows build artifacts for the new version from https://ci.appveyor.com/project/scottbelden/fastavro to the dist folder
  • Copy the linux build artifacts for the new version from https://github.com/tebeka/fastavro/releases/tag/ to the dist folder
  • Run make publish
  • Note the sha signature emitted at the above
  • Switch to feedstock directory and edit recipe/meta.yaml
    • Update version and sha256 variables at the top of the file
    • Run python recipe/test_recipe.py
    • Submit a [PR][pr]

[conda-forge]: https://conda-forge.org/ [feedstock]: https://github.com/conda-forge/fastavro-feedstock [pr]: https://conda-forge.org/#update_recipe [pypi]: https://pypi.python.org/pypi [twine]: https://pypi.python.org/pypi/twine

# Changes

See the [ChangeLog]

[ChangeLog]: https://github.com/tebeka/fastavro/blob/master/ChangeLog

# Contact

[Project Home](https://github.com/tebeka/fastavro)

Release history Release notifications | RSS feed

Download files

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

Files for fastavro, version 0.18.1
Filename, size File type Python version Upload date Hashes
Filename, size fastavro-0.18.1-cp27-cp27m-manylinux1_x86_64.whl (1.1 MB) File type Wheel Python version cp27 Upload date Hashes View
Filename, size fastavro-0.18.1-cp27-cp27m-win_amd64.whl (276.8 kB) File type Wheel Python version cp27 Upload date Hashes View
Filename, size fastavro-0.18.1-cp34-cp34m-manylinux1_x86_64.whl (1.2 MB) File type Wheel Python version cp34 Upload date Hashes View
Filename, size fastavro-0.18.1-cp35-cp35m-manylinux1_x86_64.whl (1.2 MB) File type Wheel Python version cp35 Upload date Hashes View
Filename, size fastavro-0.18.1-cp35-cp35m-win_amd64.whl (271.3 kB) File type Wheel Python version cp35 Upload date Hashes View
Filename, size fastavro-0.18.1-cp36-cp36m-manylinux1_x86_64.whl (1.3 MB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size fastavro-0.18.1-cp36-cp36m-win_amd64.whl (278.7 kB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size fastavro-0.18.1.tar.gz (446.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page