New engine

Author: jonomon

.travis.yml

@@ -2,10 +2,19 @@ language: python
 python:
  - 2.6
  - 2.7
+ - 3.2
+ - 3.3
  - pypy
 install:
  - python setup.py install
+ - pip install coveralls
 script:
- - py.test test_replays test_s2gs
+ - coverage run test_replays/test_all.py
+ - coverage run --append test_s2gs/test_all.py
+after_success:
+ - coveralls
+branches:
+  only:
+    - master
 notifications:
   irc: "chat.freenode.net#sc2reader"

CHANGELOG.rst

@@ -4,11 +4,22 @@ CHANGELOG
 0.5.2 -
 --------------------
 
+* Adds experimental SC2Map.MapInfo parsing support. Replaces the useless MapInfo resource from before.
+* Summary.teams is now summary.team; summary.team is now summary.teams. To conform with replay name conventions
+* Fixed #136, unit types from tracker events are used when available.
+* Deprecated player.gateway for player.region
+* Reorganized the person/player/observer hierarchy. Top level classes are now Computer, Participant, and Observer. Participant and Computer are both children of player so any isinstance code should still work fine.
+* Player.uid now means something completely different! Use player.toon_id instead
+* Player.uid is now the user id of the player (was player.cid)
+* PersonDict can no longer be constructed from a player list and new players cannot be added by string (name). Only integer keys accepted for setting.
+* Added a sc2json script contributed by @ChrisLundquist
 * Hooked up travis-ci for continuous testing. https://travis-ci.org/GraylinKim/sc2reader
+* Switched to built in python unittest module for testing.
 * Log a warning instead of throwing an exception when using an unknown colors.
     * An unknown hex value will use the hex value as the name.
     * An unknown color name will use 0x000000 as the color.
 
+
 0.5.1 - June 1, 2013
 --------------------
 

README.rst

@@ -45,7 +45,7 @@ description of the information that can be extracted please consult the
 `documentation`_ hosted on Read the Docs.
 
 The library is production ready and reasonably stable. `travis-ci`_ provides a
-record of continuous testing which you can `see here`_
+record of our `continuous testing`_ and `coveralls.io`_ provides a record of our `test coverage`_.
 
 
 Replays
@@ -244,16 +244,14 @@ too much work. It'll make everyone happier in the long run.
 Testing
 -------------------
 
-We use py.test for testing. You can install it via pip/easy_install::
-
-    pip install pytest
-    easy_install pytest
+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.
 
 To run the tests just use::
 
-    py.test               # Runs all the tests
-    py.test test_replays  # Only run tests on replays
-    py.test test_s2gs     # Only run tests on summary files
+    python -m unittest discover test_replays
+    python -m unittest discover test_s2gs
 
 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::
@@ -322,5 +320,7 @@ and kept this project going.
 .. _issue tracker: https://github.com/GraylinKim/sc2reader/issues
 .. _bnet_scraper: https://github.com/agoragames/bnet_scraper
 .. _sc2profile: https://github.com/srounet/sc2profile
-.. _see here: https://travis-ci.org/GraylinKim/sc2reader
+.. _continuous testing: https://travis-ci.org/GraylinKim/sc2reader
 .. _travis-ci: https://travis-ci.org/
+.. _coveralls.io: https://coveralls.io
+.. _test coverage: https://coveralls.io/r/GraylinKim/sc2reader

STYLE_GUIDE.rst

@@ -1,39 +1,27 @@
 STYLE GUIDE
 ==============
 
-Use your common sense and have some decency. Also try to stick to the following where reasonable.
+As a rough style guide, please lint your code with pep8::
 
+    pip install pep8
+    pep8 --ignore E501,E226,E241 sc2reader
 
-Absolute Imports
-----------------------
 
-Always use absolute imports::
+All files should start with the following::
 
-	from __future__ import absolute_import
+    # -*- coding: utf-8 -*-
+    #
+    # Optional Documentation on the module
+    #
+    from __future__ import absolute_import, print_function, unicode_literals, division
 
-That means imports should always start with sc2reader... instead of being relative to the current module.
+All imports should be absolute.
 
-	from sc2reader.utils import ReplayBuffer
 
+All string formatting sound be done in the following style::
 
-Explicit Imports
----------------------
+    "my {0} formatted {1} string {2}".format("super", "python", "example")
+    "the {x} style of {y} is also {z}".format(x="dict", y="arguments", z="acceptable")
 
-Prefer explicit imports to globbed imports
-
-	from sc2reader.events import ChatEvent
-
-is better than
-
-	from sc2reader.events import *
-
-
-Formatting Strings
------------------------
-
-Use string.format(args) instead string % (args).
-
-To support python 2.6, use numerical indexes even though it is a pain in the ass::
-
-	"{0} minerals, {1} gas, {2} terrazine, and {3} custom".format(self.minerals, self.vespene, self.terrazine, self.custom)
+The format argument index numbers are important for 2.6 support. ``%`` formatting is not allowed for 3.x support
 

docs/source/mainobjects.rst

@@ -24,14 +24,3 @@ Game Summary
 .. autoclass:: GameSummary
     :members:
 
-MapInfo
----------------
-
-.. autoclass:: MapInfo
-    :members:
-
-MapHeader
----------------
-
-.. autoclass:: MapHeader
-    :members:

docs/source/supportobjects.rst

@@ -6,42 +6,69 @@ Support Structures
 These dumb data structures help to give meaningful organization and structure to the information in their respective parent resources.
 
 
+Entity
+------------------
+
+.. autoclass:: Entity
+	:members:
+
 Player
 ------------------
 
 .. autoclass:: Player
     :members:
 
+User
+------------------
+
+.. autoclass:: User
+	:members:
 
 Observer
----------------
+------------------
 
 .. autoclass:: Observer
     :members:
 
+Computer
+------------------
 
-Person
--------------
+.. autoclass:: Computer
+	:members:
 
-.. autoclass:: Person
-    :members:
+Participant
+------------------
 
+.. autoclass:: Participant
+    :members:
 
 Team
-----------------
+------------------
 
 .. autoclass:: Team
 	:members:
 
 
 PlayerSummary
------------------
+------------------
 
 .. autoclass:: PlayerSummary
     :members:
 
 Graph
------------
+------------------
 
 .. autoclass:: Graph
     :members:
+
+MapInfo
+------------------
+
+.. autoclass:: MapInfo
+	:members:
+
+MapInfoPlayer
+------------------
+
+.. autoclass:: MapInfoPlayer
+	:members: