Merge branch '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/

CONTRIBUTING.md

@@ -0,0 +1,84 @@
+# Contributing to PathOfBuilding-Python
+
+## Setting up a development installation
+
+* This project targets Python 3.10. You can install it from
+[here](https://www.python.org/downloads/release/python-3100/).
+* For dependency management, we use [poetry](https://python-poetry.org/).
+Install it like so (Powershell):
+    ```shell
+    (Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/install-poetry.py -UseBasicParsing).Content | python -
+    ```
+* Run this command to clone the repository:
+    ```shell
+    git clone -b dev https://github.com/PathOfBuildingCommunity/PathOfBuilding.git
+    ```
+* Afterwards, run this command to install all dependencies:
+    ```shell
+    poetry install
+    ```
+
+## Before submitting your PR
+
+### Style guide
+
+* Code: [PEP 8](https://www.python.org/dev/peps/pep-0008/)
+* Docstrings: [PEP 257](https://www.python.org/dev/peps/pep-0257/)
+* Type hints: [PEP 484](https://www.python.org/dev/peps/pep-0484/)
+* Formatting: [black](https://github.com/psf/black) and
+[isort](https://github.com/PyCQA/isort)
+* Commit message: Follow the
+[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines
+* Branch: Pull requests must be created against the `dev` branch. It is strongly
+recommended creating a new branch off of `dev` to contain your proposed changes.
+
+Here's a primer on the specifics:
+* Class/type names: `CamelCase`
+* Variable/function/module/file names: `snake_case`.
+* Variables with values that do not change during program execution: `UPPER_SNAKE_CASE`.
+These could be literals or enum variants.
+* Mark module- or class-level implementation details by prepending a single underscore,
+like `_variable`, `_method`.
+* Do not shadow built-ins (even `id`, `help` and the like).
+Instead, append a single underscore, like `id_`, `help_.
+* Likewise for reserved keywords (`class_`, `import_`, etc.
+Please no `klass`, `clazz or similar!)
+
+In case of contradictions between individual guidelines, `black` is right.
+
+In the specific case of third-party libraries with divergent style conventions,
+follow theirs. This is in line with PEP 8.
+
+
+## Getting in touch with the developers
+
+There is a [Discord](https://discordapp.com/) server, intended for active development on
+this project. If you are interested in joining, send a private message to
+Cinnabarit#1341.
+
+## Keeping your fork up to date
+
+* Add a new remote repository and name it upstream.
+    ```shell
+    git remote add upstream https://github.com/PathOfBuildingCommunity/PathOfBuilding.git
+    ```
+* Verify that adding the remote worked.
+    ```shell
+    git remote -v
+    ```
+* Fetch all branches and their commits from upstream.
+    ```shell
+    git fetch upstream
+    ```
+* Check out your local dev branch if you haven't already.
+    ```shell
+    git checkout dev
+    ```
+* Merge all changes from upstream/dev into your local dev branch.
+    ```shell
+    git rebase upstream/dev
+    ```
+* Push your updated branch to GitHub.
+    ```shell
+    git push -f origin dev
+    ```

README.md

@@ -5,7 +5,7 @@ from Lua to Python. Currently, it is mostly intended for exploring ideas on how
 accomplish this.
 
 ## Install
-This project targets Python 3.9. You need to have Python 3.9 or later installed
+This project targets Python 3.10. You need to have Python 3.10 installed
 to run this project. Start off by cloning the repository like so:
 ```commandline
 git clone -b dev https://github.com/PathOfBuildingCommunity/PathOfBuilding-Python.git

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