Skip to content
This repository has been archived by the owner on Oct 8, 2024. It is now read-only.

Commit

Permalink
docs: added notes on docker testing
Browse files Browse the repository at this point in the history
  • Loading branch information
engnadeau committed Aug 26, 2022
1 parent 7cbdeab commit 5bd2ab8
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Social | ![Twitter Follow](https://img.shields.io/twitter/follow/engnadeau?style
- [Citing](#citing)
- [Development and Community Guidelines](#development-and-community-guidelines)
- [Local Development](#local-development)
- [Docker Development](#docker-development)
- [Dependency Management](#dependency-management)
- [Submit an Issue](#submit-an-issue)
- [Contributing](#contributing)
Expand Down Expand Up @@ -135,6 +136,23 @@ Please cite the following articles if you use `pybotics` in your research:
poetry install
```

### Docker Development

- Docker is a great tool to test the package in an isolated environment
- It is especially useful for debugging issues between python versions

```bash
# launch container attached to current directory
docker run -v $(pwd):/$(basename $(pwd)) -w /$(basename $(pwd)) -it python:3 bash

# install deps
pip install poetry
poetry install

# run tests
make test
```

### Dependency Management

```bash
Expand Down

0 comments on commit 5bd2ab8

Please sign in to comment.