Skip to content

Commit

Permalink
Split-dependencies-into-groups (#129)
Browse files Browse the repository at this point in the history
* split dependencies into groups

* add make commands

* update lint workflow

* rename to lint.yaml instead of ruff.yaml

* update contributing for installation of project and running tests

---------

Co-authored-by: Pavle Tabandzelic <[email protected]>
  • Loading branch information
dinjazelena and Pavle Tabandzelic authored Sep 29, 2023
1 parent b5eaa4e commit 8d99f94
Show file tree
Hide file tree
Showing 6 changed files with 88 additions and 86 deletions.
14 changes: 14 additions & 0 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Lint

on: push

jobs:
ruff:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.9
- name: Run Ruff
uses: chartboost/ruff-action@v1
17 changes: 0 additions & 17 deletions .github/workflows/ruff.yml

This file was deleted.

7 changes: 5 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ poetry env use python3.9

After that you should install all the dependencies including development:
```shell
poetry install
make install_deps
```

#### Setup Java
Expand All @@ -53,7 +53,10 @@ To run spark tests you need to have properly configured Java. Apache Spark curre
### Rinning Tests

This project uses `pytest` and `chispa` for running spark tests. Please run all the tests before creating a pull request. In the case when you are working on new functionality you should also add new tests.

You can run test as following:
```shell
make test
```
### Code style

This project follows the [PySpark style guide](https:/MrPowers/spark-style-guide/blob/main/PYSPARK_STYLE_GUIDE.md). All public functions and methods should be documented in `README.md` and also should have docstrings in `sphinx format`:
Expand Down
17 changes: 17 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# COMMON CLI COMMANDS FOR DEVELOPMENT

.PHONY: install_deps
install_deps:
@poetry install --with=development,linting,testing,docs

.PHONY: update_deps
update_deps:
@poetry update --with=development,linting,testing,docs

.PHONY: test
test:
@poetry run pytest tests

.PHONY: lint
lint:
@poetry run ruff check --fix quinn
Loading

0 comments on commit 8d99f94

Please sign in to comment.