Merge remote-tracking branch 'upstream/upstream' into add_stetmann

Author: StoicLoofah

.circleci/config.yml

@@ -1,32 +1,44 @@
 version: 2.0
 
-my-steps: &steps
+build_and_test: &build_and_test_steps
   - checkout
   - run: sudo pip install -r requirements.txt
-  - run: sudo pip install flake8 pytest
+  - run: pip install --user .
+  - run: sudo pip install pytest
   - run: python --version ; pip --version ; pwd ; ls -l
-  # stop the build if there are Python syntax errors or undefined names
-  - run: flake8 . --count --select=E901,E999,F821,F822,F823 --show-source --statistics
-  # exit-zero treats all errors as warnings.  The GitHub editor is 127 chars wide
-  - run: flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-  #- run: pytest # test_s2gs test_replays
-  - run: python -m unittest discover test_s2gs
-  - run: python -m unittest discover test_replays
+  - run: pytest
+
 
 jobs:
+  StyleCheck:
+    docker:
+      - image: circleci/python:3.7
+    steps:
+      - checkout
+      - run: sudo pip install flake8 black
+      - run: python --version ; pip --version ; pwd ; ls -l
+      # stop the build if there are Python syntax errors or undefined names
+      - run: flake8 . --count --select=E901,E999,F821,F822,F823 --show-source --statistics
+      # exit-zero treats all errors as warnings.  The GitHub editor is 127 chars wide
+      - run: flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - run: black . --check
+
+
   Python2:
     docker:
       - image: circleci/python:2.7.15
-    steps: *steps
+    steps: *build_and_test_steps
 
   Python3:
     docker:
       - image: circleci/python:3.7
-    steps: *steps
+    steps: *build_and_test_steps
+
 
 workflows:
   version: 2
   build:
     jobs:
+      - StyleCheck
       - Python2
       - Python3

.travis.yml

@@ -1,6 +1,10 @@
 CHANGELOG
 ============
 
+1.3.1 - November 29, 2018
+-------------------------
+* Parse backup if data is missing #69
+
 1.3.0 - November 16, 2018
 -------------------------
 * Added support for protocol 70154 (StarCraft 4.7.0)

CHANGELOG.rst

@@ -18,3 +18,18 @@ Please submit patches by pull request where possible. Patches should add a test
 
 If you are having trouble running/add/fixing tests for your patch let me know and I'll see if I can help.
 
+
+Coding Style
+==============
+
+We'd like our code to follow PEP8 coding style in this project.
+We use [python/black](https://github.com/python/black) in order to make our lives easier.
+We propose you do the same within this project, otherwise you might be asked to
+reformat your pull requests.
+
+It's really simple just:
+
+    pip install black
+    black .
+
+And [there are plugins for many editors](https://black.readthedocs.io/en/stable/editor_integration.html).

CONTRIBUTING.md

@@ -259,21 +259,36 @@ Please review the `CONTRIBUTING.md`_ file and get in touch with us before doing
 Testing
 -------------------
 
-We use the built in ``unittest`` module for testing. If you are still on Python 2.6 you will need to install ``unittest2`` because our test suite requires newer features than are included in the main distribution.
+We use ``pytest`` for testing. If you don't have it just ``pip install pytest``.
 
-To run the tests just use::
+To run the tests, just do::
 
-    python test_replays/test_all.py
-    python test_s2gs/test_all.py
+    pytest
 
-When repeatedly running tests it can be very helpful to make sure you've set a local cache directory to prevent long fetch times from battle.net::
 
-    SC2READER_CACHE_DIR=local_cache PYTHONPATH=. python -m unittest test_replays.test_all
+When repeatedly running tests it can be very helpful to make sure you've set a local cache directory to prevent long fetch times from battle.net.
+So make some local cache folder::
+
+    mkdir cache
+
+And then run the tests like this::
+
+    SC2READER_CACHE_DIR=./cache pytest
 
 To run just one test:
 
-    SC2READER_CACHE_DIR=local_cache PYTHONPATH=. python -m unittest test_replays.test_all.TestReplays.test_38749
+    SC2READER_CACHE_DIR=./cache pytest test_replays/test_replays.py::TestReplays::test_38749
+
+If you'd like to see which are the 10 slowest tests (to find performance issues maybe)::
+
+    pytest --durations=10
+
+If you want ``pytest`` to stop after the first failing test::
+
+    pytest -x
+
 
+Have a look at the very fine ``pytest`` docs for more information.
 
 Good luck, have fun!