agate-remote 0.2.1#

Build status Coverage status PyPI downloads Version License Support Python versions

agate-remote adds read support for remote files to agate.

Important links:

Install#

To install:

pip install agate-remote

For details on development or supported platforms see the agate documentation.

Usage#

agate-remote uses a monkey patching pattern to add read support for remote files to all agate.Table instances.

import agate
import agateremote

Importing agate-remote adds methods to agate.Table.

table = agate.Table.from_url('https://raw.githubusercontent.com/onyxfish/agate/master/examples/test.csv')
print(table)

agate-remote also let’s you create an Archive, which is a reference to a group of tables with a known path structure.

archive = agateremote.Archive('https://github.com/vincentarelbundock/Rdatasets/raw/master/csv/')

table = archive.get_table('sandwich/PublicSchools.csv')
print(table)

API#

agateremote.table_remote.from_url(cls, url, callback=<bound method from_csv of <class 'agate.table.Table'>>, binary=False, requests_encoding=None, **kwargs)#

Download a remote file and pass it to a Table parser.

Parameters:

  • url – URL to a file to load.

  • callback – The method to invoke to create the table. Typically either agate.Table.from_csv() or agate.Table.from_json(), but it could also be a method provided by an extension.

  • requests_encoding – An encoding to pass to requests for use when decoding the response content. (e.g. force use of ‘utf-8-sig’ when CSV has a BOM).

  • binary – If False the downloaded data will be processed as a string, otherwise it will be treated as binary data. (e.g. for Excel files)

class agateremote.archive.Archive(root, url_func=<function default_url_func>, callback=<bound method from_csv of <class 'agate.table.Table'>>)#

Bases: object

Allows for fast access to respository of remote datasets with a known path structure.

get_table(key)#

Download a remote file relative to the archive’s root and return it as a table.

Authors#

The following individuals have contributed code to agate-remote:

Changelog#

Unreleased#

  • Add Python 3.12 support.

  • Drop Python 3.7 support (end-of-life was June 27, 2023).

0.2.1 - July 13, 2021#

  • Add requests_encoding keyword argument to from_url.

0.2.0 - December 19, 2016#

  • Remove deprecated monkeypatching pattern.

  • Upgrade agate requirement to version 1.5.0.

  • Fix docstring for binary argument. (#8)

0.1.1 - February 28, 2016#

  • Fixes to documentation.

  • Update agate requirement to 1.3.0.

0.1.0 - February 5, 2016#

  • Initial version.

License#

The MIT License

Copyright (c) 2016 Christopher Groskopf and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Indices and tables#