Skip to content

Commit

Permalink
chore: Update make targets for development setup
Browse files Browse the repository at this point in the history
- Add: Comments describing targets for development setup.
- Change: Rename make targets for development environment setup and
  update target dependency.
- Change: Update use of these make targets in GitHub workflows and
  contribution guidelines.
  • Loading branch information
AnonymouX47 committed Jun 4, 2024
1 parent 67fb919 commit e0090c4
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/format_check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
python-version: ${{ matrix.python-version }}

- name: Install dependencies
run: make install-req
run: make req

- name: Check formatting with black
run: make check-format
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
python-version: ${{ matrix.python-version }}

- name: Install dependencies
run: make install-req
run: make req

- name: Lint with flake8
run: |
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ For a more detailed explanation with examples see the guide at https://cbea.ms/g
**1.** Install/upgrade the required dependencies for core development:

```shell
make install-req
make req
```
OR
```shell
Expand All @@ -220,7 +220,7 @@ pip install --upgrade -r requirements.txt
**2.** Install the package in *develop*/*editable* mode:

```shell
make install
make install-dev
```
OR
```shell
Expand All @@ -233,7 +233,7 @@ This way, the package is always available within the virtual environment.
**3.** Install the required dependencies for building the documentation:

```shell
make install-req-docs
make req-doc
```
OR
```shell
Expand Down
33 changes: 22 additions & 11 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,37 @@ _: check

# Development Environment Setup

pip:
pip: # Upgrade pip
python -m pip install --upgrade pip

install: install-req
# # [Un]Install Package

install: pip # Install package
python -m pip install .

install-dev: pip # Install package in develop/editable mode
python -m pip install -e .

install-all: pip
python -m pip install --upgrade -e . -r requirements.txt -r docs/requirements.txt
uninstall: pip # Uninstall package
python -m pip uninstall --yes termvisage

install-req: pip
python -m pip install --upgrade -r requirements.txt
# # Install Dev/Doc Dependencies

install-req-all: pip
python -m pip install --upgrade -r requirements.txt -r docs/requirements.txt
req: pip # Install dev dependencies
python -m pip install --upgrade -r requirements.txt

install-req-docs: pip
req-doc: pip # Install doc dependencies
python -m pip install --upgrade -r docs/requirements.txt

uninstall:
pip uninstall -y termvisage
req-all: req req-doc

# # Install Dev/Doc Dependencies and Package

dev: req install-dev

dev-doc: req-doc install-dev

dev-all: req-all install-dev


# Pre-commit Checks and Corrections
Expand Down

0 comments on commit e0090c4

Please sign in to comment.