Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
StoneT2000 committed Mar 7, 2024
1 parent beaebbb commit 851ea65
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
14 changes: 8 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ To start contributing, raise an issue at https://github.com/haosulab/ManiSkill2/
We recommend using Python 3.9 to build and develop on ManiSkill2 (MS2), although we currently aim to support versions 3.8 and above. To get started you must set up a conda/mamba environment which can be done as follows

```
conda create -n "ms2_dev" "python==3.9"
conda create -n "ms3_dev" "python==3.9"
git clone https://github.com/haosulab/ManiSkill2.git
cd ManiSkill2
pip install -e . # install MS2 locally
pip install pytest coverage stable-baselines3 # add development dependencies for testing purposes
pip install -e .[build] # install ManiSkill locally with testing dependencies
```

Then to setup pre-commit, run

```
pip install pre-commit
pre-commit install
```

Expand Down Expand Up @@ -50,6 +50,8 @@ pytest tests/ --pdb --pdbcls=IPython.terminal.debugger:Pdb -m "not slow"
Adapted from https://packaging.python.org/en/latest/tutorials/packaging-projects/. For some reason running build directly does not work, you have to pass in -s and -w.

```
python3 -m build -s -w
python3 -m twine upload --repository testpypi dist/*
```
python -m build -s -w
python -m twine upload --repository testpypi dist/*
```

To upload to the actual pypi repository
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
},
exclude_package_data={"": ["*.convex.stl"]},
extras_require={
"tests": ["pytest", "black", "isort"],
"dev": ["pytest", "black", "isort", "pre-commit", "build", "twine"],
"docs": [
# Note that currently sphinx 7 does not work, so we must use v6.2.1. See https://github.com/kivy/kivy/issues/8230 which tracks this issue. Once fixed we can use a later version
"sphinx==6.2.1",
Expand Down

0 comments on commit 851ea65

Please sign in to comment.