search

tensortrade-org / tensortrade

An open source reinforcement learning framework for training, evaluating, and deploying robust trading agents.
https://discord.gg/ZZ7BGWh
Apache License 2.0
4.45k stars 1.01k forks source link

Fix hyphen deprecation warning in setup.cfg. #419

Closed abstractguy closed 2 years ago

carlogrisetti commented 2 years ago

FYI you only need to merge if there have been changes on master that are conflicting (or if a lot of time has passed since the last merge\branch, and you are worried that things changed in the meantime).

Do you have any reference for this deprecation warning? I can't seem to find any documentation on this metadata section of the setup.cfg file

Here's the reference I found: https://setuptools.pypa.io/en/latest/userguide/declarative_config.html (no description_file or description-file is mentioned, thou)

abstractguy commented 2 years ago

FYI you only need to merge if there have been changes on master that are conflicting (or if a lot of time has passed since the last merge\branch, and you are worried that things changed in the meantime).

Do you have any reference for this deprecation warning? I can't seem to find any documentation on this metadata section of the setup.cfg file

Here's the reference I found: https://setuptools.pypa.io/en/latest/userguide/declarative_config.html (no description_file or description-file is mentioned, thou)

https://github.com/pypa/setuptools/issues/2595

carlogrisetti commented 2 years ago

pypa/setuptools#2595

Yeah but here it just says that they are deprecating hypens in favor of underscores. I am also trying to find what does the "translated" description_file does, since I only found references to long_description in the config files (that are always used with README.rst files, and never found an example with mkdocs README.md)

ie: I don't want to just snooze the warning, but be sure this is the correct way to do that :)

carlogrisetti commented 2 years ago

Seems this should be the correct way to address this:

description = An open source reinforcement learning framework for training, evaluating, and deploying robust trading agents.
long_description = file: README.md
long_description_content_type = text/markdown

Reference: https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/

abstractguy commented 2 years ago

Seems this should be the correct way to address this:

description = An open source reinforcement learning framework for training, evaluating, and deploying robust trading agents.
long_description = file: README.md
long_description_content_type = text/markdown

Reference: https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/

Sure. Make the changes and I'll fix the ccxt conflict. For the jupyter branch though you're leaving this to Richard?