Skip to content

Commit

Permalink
build: create separate makefile target for development install
Browse files Browse the repository at this point in the history
  • Loading branch information
eginhard committed May 8, 2024
1 parent 816b550 commit ee5b402
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The following steps are tested on an Ubuntu system.

```bash
$ make system-deps # intended to be used on Ubuntu (Debian). Let us know if you have a different OS.
$ make install
$ make install_dev
```

4. Create a new branch with an informative name for your goal.
Expand Down
7 changes: 5 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.DEFAULT_GOAL := help
.PHONY: test system-deps dev-deps deps style lint install help docs
.PHONY: test system-deps dev-deps deps style lint install install_dev help docs

help:
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
Expand Down Expand Up @@ -74,7 +74,10 @@ hub-deps: ## install deps for torch hub use
deps: ## install 🐸 requirements.
pip install -r requirements.txt

install: ## install 🐸 TTS for development.
install: ## install 🐸 TTS
pip install -e .[all]

install_dev: ## install 🐸 TTS for development.
pip install -e .[all,dev]
pre-commit install

Expand Down
2 changes: 1 addition & 1 deletion dockerfiles/Dockerfile.dev
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ RUN pip install \
COPY . /root

# Installing the TTS package itself:
RUN make install
RUN make install_dev
5 changes: 5 additions & 0 deletions docs/source/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,12 @@ This is recommended for development and more control over 🐸TTS.
git clone https://github.com/idiap/coqui-ai-TTS
cd coqui-ai-TTS
make system-deps # only on Linux systems.

# Install package and optional extras
make install

# Same as above + dev dependencies and pre-commit
make install_dev
```

## On Windows
Expand Down

0 comments on commit ee5b402

Please sign in to comment.