diff --git a/README.md b/README.md index 9aeaa8e..0168670 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,7 @@ # Reproschema Python library and Command Line Interface (CLI) - -### Installation +## Installation reproschema requires Python 3.7+. @@ -11,6 +10,24 @@ 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. @@ -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 @@ -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 -```