Skip to content

Commit

Permalink
Add dev.requirements.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
takuseno committed Nov 3, 2023
1 parent b2bd3b8 commit 2b4b67b
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 11 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/format_check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ jobs:
- name: Install packages
run: |
python -m pip install --upgrade pip
pip install Cython numpy matplotlib onnxruntime onnx pytest tensorboardX
pip install Cython numpy
pip install -e .
pip install black mypy pylint==2.13.5 isort docformatter
pip install -r dev.requirements.txt
- name: Check format
run: |
./scripts/format
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ jobs:
- name: Install packages
run: |
python -m pip install --upgrade pip
pip install Cython numpy pytest-cov onnxruntime onnx
pip install Cython numpy
pip install -e .
d3rlpy install minari
pip install -r dev.requirements.txt
- name: Unit tests
run: |
mkdir -p test_data
Expand Down
16 changes: 9 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Contribution examples:

## Development Guide

### build from source
### Build from source
```
$ git clone [email protected]:takuseno/d3rlpy
$ cd d3rlpy
Expand All @@ -18,25 +18,27 @@ $ pip install -e .

Before making your nice PR, please run the follwing commands to inspect code qualities.

### testing
### Install additional dependencies for development
```
$ pip install -r dev.requirements.txt
```

### Testing
```
$ pip install pytest-cov onnxruntime onnx # dependencies used in unit tests
$ ./scripts/test
```

### coding style
### Coding style check
This repository is styled with [black](https://github.com/psf/black) formatter.
Also, [isort](https://github.com/PyCQA/isort) is used to format package imports.
[docformatter](https://github.com/PyCQA/docformatter) is additionally used to format docstrings.
```
$ pip install black isort docformatter # formatters
$ ./scripts/format
```

### linter
### Linter
This repository is fully type-annotated and checked by [mypy](https://github.com/python/mypy).
Also, [pylint](https://github.com/PyCQA/pylint) checks code consistency.
```
$ pip install mypy pylint==2.13.5 # linters
$ ./scripts/lint
```
13 changes: 13 additions & 0 deletions dev.requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
pytest
pytest-cov
onnxruntime
onnx
matplotlib
tensorboardX
black
mypy
pylint==2.13.5
isort
docformatter
minari==0.4.2
gymnasium_robotics

0 comments on commit 2b4b67b

Please sign in to comment.