Skip to content

Commit

Permalink
Merge pull request #52 from rossumai/oh/steamline-makefile
Browse files Browse the repository at this point in the history
chore: Streamline Makefile and improve README
  • Loading branch information
asgeirrr committed Nov 1, 2023
2 parents 57af9b9 + 0b1064f commit a89e6e6
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ VENV_PATH = .venv
help:
@echo "Thanks for your interest in the Rossum Python SDK!"
@echo
@echo "make install: Install all needed dependencies including tests"
@echo "make lint: Run linters"
@echo "make test: Run basic tests (not testing most integrations)"
@echo "make test-all: Run ALL tests (slow, closest to CI)"
Expand All @@ -17,13 +18,16 @@ help:
virtualenv -ppython3 $(VENV_PATH)
$(VENV_PATH)/bin/pip install tox

install:
$(VENV_PATH)/bin/pip install -e '.[tests]'

format: .venv
$(VENV_PATH)/bin/tox -e linting --notest
.tox/linting/bin/black .
.PHONY: format

test: .venv
@$(VENV_PATH)/bin/tox -e py39
pytest tests
.PHONY: test

lint: .venv
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,17 @@ def main_with_sync_client():
main_with_sync_client()
```

### Development

There is a `Makefile` that can help you setup a development environment quickly, run the following commands

```
make .venv # Creates virtualenv in .venv folder
make install # Installs all project dependencies including test ones
```

Run `make help` to see more available actions.

### TODO

* convert datetimes to ISO 8601 string in `APIClient` to allow users passing standard datetime objects
Expand Down

0 comments on commit a89e6e6

Please sign in to comment.