Updates for the elixir version of SimEngine

.github/workflows/main.yml

@@ -12,7 +12,7 @@ on:
       - main
 
 jobs:
-  linting:
+  lint_and_pytest:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -47,12 +47,15 @@ jobs:
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=100 --statistics
+    - name: Pytest
+      run: |
+        pytest
     - name: Run linting environment and pre-commit hooks
       run: |
         tox -e lint
 
 
-  tox-coveralls:
+  coveralls:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -61,26 +64,12 @@ jobs:
         with:
           python-version: 3.7
 
-      - name: Set up Python 3.8
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.8
-
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-
       - name: Install python dependencies
         run: |
           python -m pip install --upgrade pip
           python -m pip install tox pytest pytest-cov coverage responses
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
 
-      - name: Tox testenv
-        run: |
-          tox
-
       - name: Pytest
         run: |
           pytest
@@ -92,7 +81,7 @@ jobs:
           flag-name: Python Test Suite
 
   coveralls_finish:
-    needs: tox-coveralls
+    needs: coveralls
     runs-on: ubuntu-latest
     steps:
       - name: Coveralls Finished

README.md

@@ -76,37 +76,30 @@ on `osx / linux / bashonwindows`:
 curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
 ```
 
-- Once you have **Poetry** installed you need to install the projects dependencies with this command:
+- Once you have **Poetry** installed you need to install the projects dependencies with this command from the project root:
 
 ```bash
-poetry install
+bin/setup
 ```
+- This script will install all dependencies specified in `pyproject.toml` via `Poetry` and install the `pre-commit` hooks
+this project uses.
 
-- After you have installed **Poetry**, you need to start the python environment managed by Poetry by
-  running `poetry shell` in your terminal.
-
+## Adding dependencies to the project
+If your changes require you to install a python package/module using `poetry add <some package>` or
+`poetry add <some package> -D` for a dev dependency. You will also need to run the following command to
+regenerate a `requirements.txt` file that includes the newly added dependencies:
 ```bash
-poetry shell
- ```
+poetry export -f requirements.txt --output requirements.txt --without-hashes --dev
+```
 
-### Pre-Commit Hooks
+## Pre-Commit Hooks
 We are using [Pre-Commit](https://pre-commit.com/) to enforce formatting, lint rules, and code analysis so that
 this repo is always in good health.
- - If you choose not to globally install `pre-commit`, then you can skip installing via `pip` or `homebrew` directly.
-   You can simply run either `pip install -r requirements.txt` or `poetry install`
-To be able to push a PR to the repo after making changes locally, you will need to install `pre-commit` which
-is a tool that runs linting, formatting, and code analysis on your changes.
-```bash
-pip install pre-commit  # Install via pip
+- `Pre-Commit` is installed and initialized when you run `bin/setup` from the project root as outlined above.
 
-OR
-
-brew install pre-commit  # Install via homebrew
-```
-- After you have run either `pip install -r requirements.txt`, `poetry install`, or globally installed
-  [Pre-Commit](https://pre-commit.com/) using the above commands you need to run the following command
-  in the project directory locally. This allows the pre-commit hooks to run when you are looking to commit
-  and push code to this repository.
+- If you choose not to use `Poetry` and prefer `pip` you can simply run `pip install -r requirements.txt`
+To be able to commit & push a PR to the repo after making changes locally, you will need to install `pre-commit` which
+is a tool that runs tests, linting, formatting, and code analysis on your changes.
 ```bash
 pre-commit install
 ```

bin/setup

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+poetry install
+pre-commit install
+poetry shell