Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs and docs build update #17

Merged
merged 2 commits into from
Feb 10, 2023
Merged

Docs and docs build update #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f00ccf6
build: add readthedocs config requiring python 3.9
mslw Feb 9, 2023
a2309de
docs: update readme
mslw Feb 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
version: 2

build:
os: "ubuntu-22.04"
tools:
python: "3.9"

sphinx:
configuration: docs/source/conf.py

python:
install:
- method: pip
path: .
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,29 @@
# DataLad REDCap extension

[![crippled-filesystems](https://github.com/datalad/datalad-redcap/workflows/crippled-filesystems/badge.svg)](https://github.com/datalad/datalad-redcap/actions/workflows/test_crippledfs.yml)
[![docs](https://github.com/datalad/datalad-redcap/workflows/docs/badge.svg)](https://github.com/datalad/datalad-redcap/actions/workflows/docbuild.yml)

[![crippled-filesystems](https://github.com/datalad/datalad-redcap/workflows/crippled-filesystems/badge.svg)](https://github.com/datalad/datalad-redcap/actions/workflows/test_crippledfs.yml)
[![Documentation Status](https://readthedocs.org/projects/datalad-redcap/badge/?version=latest)](http://docs.datalad.org/projects/redcap/en/latest/?badge=latest)

This DataLad extension provides convenience commands for exporting data from REDCap into DataLad datasets.
Information about the RedCAP project can be found at https://project-redcap.org/.

The extension is in early development.

## Installation
The extension has no official release yet, but you can install the *bleeding edge* version using pip, directly from GitHub.
This will also install the latest development version of [DataLad Next](https://github.com/datalad/datalad-next) extension.
Using a virtual environment is recommended.
Example installation:

```
# create and enter a new virtual environment (optional)
$ virtualenv --python=python3 ~/env/dl-redcap
$ source ~/env/dl-redcap/bin/activate
# install from GitHub main branch
$ python -m pip install git+https://github.com/datalad/datalad-redcap.git@main
```

## Commands
- `export-redcap-form`: Export records from selected forms (instruments)
- `export-redcap-report`: Export a report that was defined in a project
Expand Down