Python 3, pypi package, and module support

Blizzard / heroprotocol

Python library to decode Heroes of the Storm replays

MIT License

397 stars 71 forks source link

Python 3, pypi package, and module support #90

Closed Agilhardt closed 4 years ago

Agilhardt commented 4 years ago

Updates to support both Python 2.7 and Python 3.x
Package now publishes to PyPI (https://pypi.org/project/heroprotocol)
New method of invoke, instead of python heroprotocol.py [...], run python -m heroprotocol [...]. This works either with the PyPI package installed, or running from source at the checkout root.

Resolves #4, resolves #5, resolves #57, resolves #59, resolves #85, resolves #86, resolves #88.

Agilhardt commented 4 years ago

I'm going to leave this here to soak for a week or two. @MGatner, @healingbrew, @koliva8245, @Astraeus-, @patonz, and anyone else who is using this library directly, please test it and send feedback. Also, please test the published package available on PyPI: pip install --upgrade heroprotocol.

ebshimizu commented 4 years ago

While not exactly a python use case, the javascript parser (nydus/heroprotocol) downloads the protocol files and uses them as templates for its implementation. It looks like that package will be ok with the changes once the path to the protocol files is updated. Thankfully, that's a super small change to make (not sure if the maintainer for that project is still around), and it looks like the package is working correctly on the develop branch. Will do a bit more testing this weekend.

patonz commented 4 years ago

Got some issues with alpine during docker build, i will check again asap

Agilhardt commented 4 years ago

Got some issues with alpine during docker build, i will check again asap

@patonz Good catch, six is missing from the pypi package requirements. Will address with the next push. For now you can pip install six as a workaround.

ebshimizu commented 4 years ago

While not exactly a python use case, the javascript parser (nydus/heroprotocol)...

Ran through a few hundred recent replays using the develop branch with nydus/heroprotocol this weekend and it looks like it's working just fine. Should be good to go there.

Agilhardt commented 4 years ago

For awareness, I published heroprotocol-2.50.1.79515.post1 to PyPI which resolves the missing dependency. https://pypi.org/project/heroprotocol/2.50.1.79515.post1/