Skip to content

Commit

Permalink
APPS-1598: document building dx-toolkit in docker (#911)
Browse files Browse the repository at this point in the history
* APPS-1598: Add documentation on build inside docker

* APPS-1598: Add readme

* APPS-1598: formating OS X

* APPS-1598: formating

* Update Readme-developer.md

Co-authored-by: Marek Hrvol <[email protected]>

* APPS-1598: step 2b

* APPS: moved content to /Readme.md

Co-authored-by: piader1 <>
Co-authored-by: Marek Hrvol <[email protected]>
  • Loading branch information
Matej Stevuliak and mhrvol authored Jan 13, 2023
1 parent 5748634 commit ad4330a
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Readme-osx.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ https://documentation.dnanexus.com/downloads
```
CC=clang CXX=clang++ VERSIONER_PERL_VERSION=5.16 make ua
```
```
20 changes: 20 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,26 @@ Client](https://documentation.dnanexus.com/getting-started/tutorials/cli-quickst
utilities, and you will be able to use DNAnexus API bindings in the supported
languages.

### Building inside docker
To avoid lengthy installation of dependencies on OS X and simultaneous installations of development versions of `dx-toolkit` on the system, you can build your dev-version of `dx-toolkit` in a separate docker container.

1. Start `python:3.9-bullseye` in the interactive mode, mounting the repo you are working on (`<local_path_to_repo>/dx-toolkit`):

```
# from root folder of dx-tollkit
docker run -v `pwd`:/dx-toolkit -w /dx-toolkit -it --rm --entrypoint=/bin/bash python:3.9-bullseye
```
2. From the interactive shell install `dx-toolkit`.
- **A.** Use local source:
```
python -m pip install src/python/ --upgrade
```
- **B.** Use remote source:
```
python3 -m pip install --upgrade 'git+https://github.com/dnanexus/dx-toolkit.git@master#egg=dxpy&subdirectory=src/python'
```
3. Log in, install dependencies(if needed) and use the container while developing. To rebuild, just save the work and run the step 2 again.
Supported languages
-------------------
Expand Down

0 comments on commit ad4330a

Please sign in to comment.