chore: re-organise test app

- move example to test/testapp
- consolidate tests in one location

.github/workflows/ci.yml

@@ -43,26 +43,29 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           cache: 'pip'
+          cache-dependency-path: |
+            tests/requirements.txt
 
       - name: Install Dependencies
         run: |
-          pip install -r requirements.txt
-          pip install .
+          cd tests
+          python -m pip install --upgrade pip
+          python -m pip install -r requirements.txt
 
       - name: Install Wagtail package
         if: ${{ matrix.wagtail-version != 'main' }}
         run: |
-          pip install wagtail==${{ matrix.wagtail-version }}
+          python -m pip install wagtail==${{ matrix.wagtail-version }}
 
       - name: Install Wagtail main
         if: ${{ matrix.wagtail-version == 'main' }}
         run: |
           git clone https://github.com/wagtail/wagtail.git
-          pip install ./wagtail
+          python -m pip install ./wagtail
 
       - name: Run Tests
         run: |
-          cd example
+          cd tests
           python manage.py migrate
           python manage.py test
 
@@ -76,15 +79,16 @@ jobs:
           python-version: 3.8
           cache: 'pip'
           cache-dependency-path: |
-            requirements-channels.txt
+            tests/requirements-channels.txt
 
       - name: Install Dependencies
         run: |
-          pip install -r requirements-channels.txt
-          pip install .
+          cd tests
+          python -m pip install --upgrade pip
+          python -m pip install -r requirements-channels.txt
 
       - name: Run Tests
         run: |
-          cd example
+          cd tests
           python manage.py migrate
           python manage.py test

.gitignore

@@ -1,7 +1,6 @@
 ### Django ###
 *.log
 *.pot
-*.pyc
 __pycache__/
 local_settings.py
 media
@@ -139,3 +138,7 @@ Temporary Items
 *.sublime-workspace
 .vscode
 .idea
+
+
+# wagtail
+static/

Dockerfile

@@ -21,18 +21,18 @@ COPY ./requirements-channels.txt /code/requirements-channels.txt
 COPY ./requirements.txt /code/requirements.txt
 
 # copy example site requires file
-COPY ./example/requirements.txt /code/example/requirements.txt
-COPY ./example/requirements-channels.txt /code/example/requirements-channels.txt
+COPY ./tests/requirements.txt /code/tests/requirements.txt
+COPY ./tests/requirements-channels.txt /code/tests/requirements-channels.txt
 
-WORKDIR /code/example
+WORKDIR /code/tests
 
 RUN pip install --upgrade pip
 # Install any needed packages specified in requirements.txt
 RUN pip install -r ./requirements-channels.txt
 RUN pip install gunicorn
 
 # Copy the current directory contents into the container at /code/
-COPY ./example /code/example
+COPY ./tests /code/tests
 # Set the working directory to /code/
 
 RUN python manage.py migrate

README.md

@@ -175,23 +175,22 @@ Any contributions [you make](https://github.com/torchbox/wagtail-grapple/graphs/
 
 ### Local development
 
-#### With SQLite
--   In the Python environment of your choice, navigate to `/example`
--   Run `pip install -r requirements.txt`
--   Run `./manage.py migrate`
--   Run server `./manage.py runserver`
--   Run tests `./manage.py test`
+-   In the Python environment of your choice, navigate to `tests/`
+-   Run `python -m pip install -r requirements.txt`
+-   Run `python manage.py migrate`
+-   Run server `python manage.py runserver`
+-   Run tests `python manage.py test`
 
 #### With Postgres
 
--   In the Python environment of your choice, navigate to `/example`
--   Run `pip install -r requirements.txt`
 -   Ensure you have docker and docker compose
 -   Run `docker compose up`
 -   Run `export DATABASE_URL="postgres://postgres:postgres@localhost/postgres"`
--   Run `./manage.py migrate`
--   Run server `./manage.py runserver`
--   Run tests `./manage.py test`
+-   In the Python environment of your choice, navigate to `tests/`
+-   Run `python -m pip install -r requirements.txt`
+-   Run `python manage.py migrate`
+-   Run server `python manage.py runserver`
+-   Run tests `python manage.py test`
 
 ## Compatibility