Merge pull request #6 from Bloodmallet/9-0-shadowlands

9 0 shadowlands

.github/workflows/CI.yml

@@ -0,0 +1,37 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest pytest-cov
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=400 --statistics
+    - name: Test with pytest
+      run: |
+        pytest --doctest-modules --junitxml=junit/test-results.xml --cov=simc_support --cov-report=xml --cov-report=html

.gitignore

@@ -1,20 +1,20 @@
-# Compiled python modules.
-*.pyc
-
-# Setuptools distribution folder.
-/dist/
-
-# Python egg metadata, regenerated from source files by setuptools.
-/*.egg-info
-
-# build directory from adding installing in local dev
-/build/
-
-# local dev environement
-/env/
-
-/__pycache__/
-
+# directories
+__pycache__/
 .mypy_cache/
-
+.pytest_cache/
 .vscode/
+# build directory from adding installing in local dev
+build/
+dist/
+env*/
+htmlcov/
+junit/
+tmp/
+
+# files
+.coverage
+# Python egg metadata, regenerated from source files by setuptools.
+*.egg-info
+*.pyc
+*.simc
+coverage.xml

README.md

@@ -1,2 +1,31 @@
-# simc_support
-libs to support with wow data and simc data
+# simc_support [![CI](https://github.com/Bloodmallet/simc_support/workflows/CI/badge.svg)](https://github.com/Bloodmallet/simc_support/actions?query=workflow%3A%22CI%22)
+
+Data to support simulations for World of Warcraft with SimulationCraft for each current expansion. First three versioning numbers match World of Warcrafts' build version.
+
+## Installation
+
+```sh
+pip install simc-support
+```
+
+## Usage
+
+Get a list of all trinkets
+```python
+from simc_support.game_data.Trinket import TRINKETS
+
+for trinket in TRINKETS:
+    print(f"{trinket.item_id} {trinket.name}")
+```
+
+Get a list of all trinkets available to a specific spec
+```python
+from simc_support.game_data.WowSpec import get_wow_spec
+from simc_support.game_data.Trinket import get_trinkets_for_spec
+
+elemental_shaman = get_wow_spec("shaman", "elemental")
+trinkets = get_trinkets_for_spec(elemental_shaman)
+
+for trinket in TRINKETS:
+    print(f"{trinket.item_id} {trinket.name}")
+```

publish_release.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+echo "Activating environment"
+. ./env/bin/activate
+
+echo "Removing old artifacts"
+for D in "build" "dist" "simc_support.egg-info"; do
+    if [ -d "${D}" ]; then
+        rm -r ${D}
+    fi
+done
+
+echo "Install requirements"
+pip install -U -r requirements.txt
+pip install -U setuptools wheel twine
+
+echo "Execute unittest"
+python -m unittest
+
+echo "Build wheel"
+python setup.py sdist bdist_wheel
+
+echo "Publish"
+python -m twine upload dist/*

requirements.txt

@@ -0,0 +1,5 @@
+black
+mypy
+fixedint
+requests
+bitarray

setup.py

@@ -1,27 +1,35 @@
-#!/usr/bin/env python
-
-from setuptools import setup
+from setuptools import find_packages, setup
 
 
 def readme():
-    with open('README.md') as f:
+    with open("README.md") as f:
         return f.read()
 
 
 setup(
-    name='simc_support',
-    version='8.3.0.0',
-    author='Bloodmallet(EU)',
-    author_email='[email protected]',
-    description='This package offers some World of Warcraft related ingame data regularly used for simulations and some basic input test for standard values of SimulationCraft.',
+    name="simc_support",
+    # schema: <wow_version, e.g. 9.0.1>.<own_version_per_wow_version><a/b/rc alpha/beta/release candidate bit><bit_id>
+    version="9.0.2.4",
+    author="Bloodmallet(EU)",
+    author_email="[email protected]",
+    description="Data to support simulations for World of Warcraft with SimulationCraft.",
     long_description=readme(),
-    url='https://github.com/Bloodmallet/simc_support',
-    packages=[
-        'simc_support',
+    long_description_content_type="text/markdown",
+    url="https://github.com/Bloodmallet/simc_support",
+    packages=find_packages(),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+        "Operating System :: OS Independent",
     ],
     package_data={
-        "": ["*.md",],
+        "": [
+            "*.md",
+        ],
+        "simc_support": [
+            "game_data/data_files/*.json",
+        ],
     },
-    python_requires='>=3.6',
-    license='GNU GENERAL PUBLIC LICENSE',
+    python_requires=">=3.6",
+    license="GNU GENERAL PUBLIC LICENSE",
 )

simc_support/__init__.py

@@ -1,4 +0,0 @@
-__all__ = [ "simc_checks", "wow_lib" ]
-
-from . import simc_checks
-from . import wow_lib