Skip to main content
https://img.shields.io/badge/license-AGPL3.0-informational?logo=gnu&color=success https://www.repostatus.org/badges/latest/suspended.svg PyPI Version https://img.shields.io/badge/documentation-api-green https://gitlab.huma-num.fr/datasphere/heimdall/connectors/collectiveaccess/badges/main/pipeline.svg https://gitlab.huma-num.fr/datasphere/heimdall/connectors/collectiveaccess/badges/main/coverage.svg

What is this?

Heimdall is a tool for converting more easily one or more databases from one format to another. It leverages modules called “connectors”, responsible for conversion of data between specific databases schemas and the HERA format.

This repository containes a connector to CollectiveAccess server sharing their data with the CollectiveAccess Web Service API.

Why should I use it?

You can use this connector, along with the pyheimdall software, to retrieve any data from a CollectiveAccess server. You can then aggregate this data into your research corpus easily, for example using other Heimdall connectors.

Take note, however that some legal restrictions might apply to data retrieved from CollectiveAccess.
Plus, if at the end of your project, you share your data, please cite the original data properly (and reuploading it elsewhere is probably a bad idea, too).

How can I use it?

Setup

This CollectiveAccess pyHeimdall connector is available as a PyPI package named pyheimdall-colectiveaccess. You can install it using the pip package manager:

pip install pyheimdall-collectiveaccess

You can use pip to either upgrade or uninstall this connector, too:

pip install --upgrade pyheimdall-collectiveaccess
pip uninstall pyheimdall-collectiveaccess

Usage

import heimdall

tree = heimdall.getDatabase(format='api:collectiveaccess', url=...)
heimdall.createDatabase(tree, format=..., url=...)

Please note that you don’t need to use pyheimdall-collectiveaccess functions directly. As long as the package is installed on your system, pyHeimdall will automatically discover its features and allow you to use them as long as any other default or external connector.

Is it tested?

Of course! Here’s the coverage report.

How can I contribute?

PyHeimdall welcomes any feedback or proposal. Details can be accessed here

License

GNU Affero General Public License version 3.0 or later

Metadata

Release files for pyheimdall-collectiveaccess 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyheimdall-collectiveaccess 0.7.0
File Size Uploaded
pyheimdall_collectiveaccess-0.7.0.tar.gz 16.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyheimdall-collectiveaccess 0.7.0
File Interpreter ABI Platform
pyheimdall_collectiveaccess-0.7.0-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 33.7 kB

Release files / pyheimdall_collectiveaccess-0.7.0.tar.gz

Download URL pyheimdall_collectiveaccess-0.7.0.tar.gz
Size 16.8 kB
Tags Source
SHA-256 checksum
How to use checksums
72a0437252ee0e58a8471a4859e2214e26f1ef83f996f508c2d32f1cb0b5456c
BLAKE2b-256 checksum
How to use checksums
375e433c53eba74d8b798e3012bd8649c28622e3db3c7344a3a26dda304099cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.11.4

Release files / pyheimdall_collectiveaccess-0.7.0-py2.py3-none-any.whl

Download URL pyheimdall_collectiveaccess-0.7.0-py2.py3-none-any.whl
Size 16.9 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
c9d82fc3c8db57dc94ef7476f18e2e9b701f07a7e70271ee26d19e78ac8150a5
BLAKE2b-256 checksum
How to use checksums
7e18336cbbe8cd1835239c1681d21182220257779bd66f7187d4a689d3c0a852
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.11.4

Release history Release notifications | RSS feed

This release

0.7.0 This release

2 release files

0.6.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page