Merge branch 'master' into dev

Author: ppoelzl

.gitignore

@@ -0,0 +1,130 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+*.swp
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

docs/code_structure.md

@@ -0,0 +1,66 @@
+# Python Object Enumeration Thoughts
+
+[dict] All GGPK Extracted Gems { act_str, act_dex, act_int, sup_str, sup_dex, sup_str }
+  -- addressable by name
+
+[dict] All Uniques (sub-partitioned by item type)
+  -- addressable by name
+  -- can return applicable list based on item type
+
+[class] Environment
+    [dict] Environment Configuration
+
+[class] Build
+    [ref] Tree
+    [ref] Player
+
+[class] Tree
+    [str] version
+    [dict] All Nodes (addressable by Node ID)
+    [dict] Selected Nodes (addressable by Node ID)
+
+[class] Player
+    [enum] Class Selection
+    [enum] Ascendancy Selection
+    [dict] Stats (e.g. Str/Dex/Int, Hit/Crit, Life/Mana, Block/Spell Block/Evade/Dodge, etc.)
+    [dict] Item Slots
+        [per slot ref] Item
+    [optional list] Minions
+
+[class] Item
+    [dict] Attribute requirements
+    [list] Modifiers
+    [optional ref] Skill class (for skills granted by items)
+
+[class] Skill
+    [dict] Requirements (per level Str, Dex, Int)
+    [list] Granted Effect reference
+    [list] Supports
+
+[class] GrantedEffect
+    [str] Name
+    [dict] PerLevelEffects
+
+[class] Minion
+    [ref] Player
+    [dict] Stats
+    [ref list] Items
+    [ref list] Skills
+    [int] Quantity
+
+[class] EnemyModel (e.g. Shaper, Maven)
+    [dict] Stats (e.g. Str/Dex/Int, Hit/Crit, Life/Mana, Block/Spell Block/Evade/Dodge, etc.)
+
+[class] Simulator
+    [ref] Environment(s)
+    [ref list] Build(s)
+    [ref] Enemy Model(s)
+
+[class] Analytics Module
+    [func] Node Comparison
+    [func] Item Comparison
+    [func] Gem Comparison
+
+[list] Saved Builds
+
+[dict] UI API imports/exports