surveydata Python Package Documentation
The surveydata
Python package offers flexible access to survey data and support for
multiple local and cloud storage options.
Installation
Installing the latest version with pip:
pip install surveydata
Overview
To use the surveydata
package, you access data from specific survey platforms via an
appropriate SurveyPlatform
object:
SurveyCTOPlatform
provides support for SurveyCTO data, including methods to process text audits and submit submission updates via the review and correction workflow (in support of SurveyCTO’s machine learning roadmap, with the ml4qc project)ODKPlatform
provides support for Open Data Kit data via an ODK Central server
All survey data must be stored somewhere, and storage is handled via an appropriate
StorageSystem
object:
FileStorage
provides support for local file storageS3Storage
provides support for AWS S3 storageDynamoDBStorage
provides support for AWS DynamoDB storageGoogleCloudStorage
provides support for Google Cloud StorageAzureBlobStorage
provides support for Azure Blob StorageSurveyCTOExportStorage
provides support for local data exported with SurveyCTO Desktop (in wide format)ODKExportStorage
provides support for local data downloaded and unzipped from an ODK Central All data and Attachments export
In general, the workflow goes like this:
Initialize the survey platform
Initialize one or more storage systems
Synchronize data between the survey platform and the storage system(s) to ensure that data in storage is fully up-to-date (except for static export storage, via
SurveyCTOExportStorage
orODKExportStorage
, which doesn’t require synchronization)Load data and/or attachments via the survey platform and storage API’s
Optionally: Save processed data and then, later, load it back again, for cases where ingestion and processing tasks are separated from actual analysis or use
Examples
See these notebooks for detailed usage examples:
Reference
- surveydata
- surveydata package
- Submodules
- surveydata.azureblobstorage module
- surveydata.dynamodbstorage module
- surveydata.filestorage module
- surveydata.googlecloudstorage module
- surveydata.odkexportstorage module
- surveydata.odkplatform module
- surveydata.s3storage module
- surveydata.storagesystem module
- surveydata.surveyctoexportstorage module
- surveydata.surveyctoplatform module
- surveydata.surveyplatform module
- Module contents
- Submodules
- surveydata package