Skip to content

Commit

Permalink
Merge branch 'master' into reproschema2redcap
Browse files Browse the repository at this point in the history
  • Loading branch information
yibeichan committed Jan 8, 2024
2 parents 42314d9 + 7ed30f1 commit 9dd2952
Showing 1 changed file with 21 additions and 23 deletions.
44 changes: 21 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,32 @@

# Reproschema Python library and Command Line Interface (CLI)


### Installation
## Installation

reproschema requires Python 3.7+.

```
pip install reproschema
```

### Developer installation

Install repo in developer mode:

```
git clone https://github.com/ReproNim/reproschema-py.git
cd reproschema-py
pip install -e .[dev]
```

It is also useful to install pre-commit, which takes care of styling when
committing code. When pre-commit is used you may have to run git commit twice,
since pre-commit may make additional changes to your code for styling and will
not commit these changes by default:

```
pre-commit install
```
## CLI usage

This package installs `reproschema` a CLI.
Expand All @@ -31,9 +48,9 @@ Options:
Log level name [default: INFO]
--help Show this message and exit.
Commands:
convert
convert
create
redcap2reproschema Convert REDCap CSV files to Reproschema format.
serve
validate
reproschema2redcap
Expand Down Expand Up @@ -121,22 +138,3 @@ After configuring the YAML file:
### Notes
1. The script requires an active internet connection to access the GitHub repository.
2. Make sure you use `git add`, `git commit`, `git push` properly afterwards to maintain a good version control for your converted data.

## Developer installation

Install repo in developer mode:

```
git clone https://github.com/ReproNim/reproschema-py.git
cd reproschema-py
pip install -e .[dev]
```

It is also useful to install pre-commit, which takes care of styling when
committing code. When pre-commit is used you may have to run git commit twice,
since pre-commit may make additional changes to your code for styling and will
not commit these changes by default:

```
pre-commit install
```

0 comments on commit 9dd2952

Please sign in to comment.