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.

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

Update README.md #394

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ GDC Data Model
Repo to keep information about the GDC data model design.

- [GDC Data Model](#gdc-data-model)
- [Developing](#developing-and-building-the-dependencies)
- [Installation](#installation)
- [Jupyter + Graphviz](#jupyter--graphviz)
- [Documentation](#documentation)
Expand All @@ -19,6 +20,18 @@ Repo to keep information about the GDC data model design.
- [Setup pre-commit hook to check for secrets](#setup-pre-commit-hook-to-check-for-secrets)
- [Contributing](#contributing)

# Developing and building the dependencies
Using a python3.5 environment
```
pip install --force-reinstall pip-tools==5.5.0
pip install --force-reinstall -v "setuptools_scm==5.0.2"
pip install pre-commit
pip-compile setup.py
pip-compile dev-requirements.in
```
If you are having trouble with your pre-commit, you may want to check your `.git/hooks/pre-commit` file. The python 3.5 throws an error when using the `ARGS=(hook-impl --config=.pre-commit-config.yaml --hook-type=pre-commit --skip-on-missing-config)`. You can remove the ARGS and rerun the `git commit`


# Installation

To install the gdcdatamodel library run the setup script:
Expand Down