Dataforge
Dataforge is a Python package containing tools for creating and packaging data products.
Installation
To install dataforge:
pip install dataforge
Optional Frictionless plugins can be enabled by installing with the frictionless option:
pip install dataforge[frictionless]
Optional REDCap support requires xmarshal, which must be compiled using Cython. Thus, prior to installation, you will need a C compiler:
- Linux
sudo apt-get install build-essential
- Mac OS X
Install Apple’s XCode from the App Store
- Windows
Install Microsoft’s C++ Build Tools
Once you have a C compiler, you may install dataforge with REDCap support using:
pip install dataforge[redcap]
Configuration
For ease of use, many arguments and options for executable commands as well as many function arguments may be specified in a file called config.yaml located at the root of your project. For example, you could specify arguments and options for the redcap_export command by creating a config.yaml file containing something like this:
sources.redcap.api:
url: https://redcap.uchicago.edu/api/
project_name: MyREDCapProject
outdir: tmp/redcap
REDCap
Management of API Tokens
To access a REDCap project via the API, you will need to obtain a REDCap API token. To avoid having to enter the token each time you export data, it is convenient to add the token to your system keyring. You may do this with the following command:
keyring set <redcap_hostname> [<project_name>]
where <redcap_hostname> is the hostname of your REDCap server (e.g., redcap.uchicago.edu) and <project_name> is an abbreviated (no spaces) name of the REDCap project (e.g., MyREDCapProject). Although specifying a project name is not required, doing so will allow you to store API tokens for multiple projects. When you are asked to enter a password, enter the API token you obtained for your project.
1 maintainer
Metadata
1 maintainer
Release files for dataforge 0.0.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| dataforge-0.0.7.tar.gz | 22.7 kB | Without provenance | Details |
Release files / dataforge-0.0.7.tar.gz
| Download URL | dataforge-0.0.7.tar.gz |
|---|---|
| Size | 22.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
28c3c8dfe84ce282bfce63f9c179773bcebe4864a53f3d82e21bb7b185ed3dd8
|
|
BLAKE2b-256 checksum How to use checksums |
a33d7cead36938efcb248b6d74c626a15b367b216ff45a6f5fea7d858f7914cc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|
Security for dataforge 0.0.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
