From fd7b10600dc85014caa1aee9e49e8bb181175367 Mon Sep 17 00:00:00 2001 From: Joe Flack Date: Wed, 6 Jul 2022 19:55:25 -0400 Subject: [PATCH] Documentation for dev/setup (#162) Documentation - Updates: README.md: (i) reorganized/added 'dev' section, (ii) added project setup steps. Co-authored-by: Chris Mungall --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5c646eb8f..8e7703e94 100644 --- a/README.md +++ b/README.md @@ -221,10 +221,21 @@ OAK uses [`pystow`](https://github.com/cthoyt/pystow) for caching. By default, this goes inside `~/.data/`, but can be configured following [these instructions](https://github.com/cthoyt/pystow#%EF%B8%8F%EF%B8%8F-configuration). -## Potential Refactoring +## Developer notes -Currently all implementations exist in this repo/module, this results in a lot of dependencies +### Local project setup +Prerequisites: +1. Python 3.9+ +2. [Poetry](https://python-poetry.org/) -One possibility is to split out each implementation into its own repo and use a plugin architecture +Setup steps: +```shell +git clone https://github.com/INCATools/ontology-access-kit.git +cd ontology-access-kit +poetry install +``` +### Potential Refactoring +Currently all implementations exist in this repo/module, this results in a lot of dependencies +One possibility is to split out each implementation into its own repo and use a plugin architecture