genyrosk/gym-chess

README doesn't specify requirement for Rust compiler for installation

AbhijeetKrishnan opened this issue · 2 comments

Running pip install -e . produces the following error message

    ERROR: Command errored out with exit status 1:
     command: /home/user/bin/python -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/home/user/gym-chess/setup.py'"'"'; __file__='"'"'/home/user/gym-chess/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' develop --no-deps
         cwd: /home/user/gym-chess/
    Complete output (12 lines):
    running develop
    running egg_info
    writing gym_chess.egg-info/PKG-INFO
    writing dependency_links to gym_chess.egg-info/dependency_links.txt
    writing requirements to gym_chess.egg-info/requires.txt
    writing top-level names to gym_chess.egg-info/top_level.txt
    reading manifest file 'gym_chess.egg-info/SOURCES.txt'
    reading manifest template 'MANIFEST.in'
    writing manifest file 'gym_chess.egg-info/SOURCES.txt'
    running build_ext
    running build_rust
    error: Can not find Rust compiler
    ----------------------------------------
ERROR: Command errored out with exit status 1: /home/user/bin/python -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/home/user/gym-chess/setup.py'"'"'; __file__='"'"'/home/user/gym-chess/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' develop --no-deps Check the logs for full command output.

The initial README instructions for setup do not mention that a Rust compiler is required. Users might want to only use the v1 version implemented in pure Python without installing a Rust compiler. Doing sudo apt install cargo fixes this issue.

true, that's a very good point !

Moreover, the EasyInstall method is meanwhile deprecated which further leads to build failure. So the Readme should be adjusted to pip install . and, in align with comments above, Visual Studio Build Tools should be mentioned as requirement.