forked from minerllabs/minerl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
setup.py
235 lines (195 loc) · 8.1 KB
/
setup.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
# Copyright (c) 2020 All Rights Reserved
# Author: William H. Guss, Brandon Houghton
import os
import sys
import json
from os.path import isdir
import subprocess
import pathlib
import setuptools
from setuptools import Command
from setuptools.command.develop import develop
from setuptools.command.install import install
from setuptools.command.install_lib import install_lib
from distutils.command.build import build
from setuptools.dist import Distribution
import shutil
with open("README.md", "r") as fh:
markdown = fh.read()
with open("requirements.txt", "r") as fh:
requirements = fh.read()
MALMO_BRANCH = "minerl"
MALMO_VERSION = "0.37.0"
MALMO_DIR = os.path.join(os.path.dirname(__file__), 'minerl', 'Malmo')
BINARIES_IGNORE = shutil.ignore_patterns(
'build',
'bin',
'dists',
'caches',
'native',
'.git',
'doc',
'*.lock',
'.gradle',
'.minecraftserver',
'.minecraft')
# TODO: THIS IS NOT ACTUALLY IGNORING THE GRADLE.
# TODO: Potentially add locks to the binary ignores.
try:
from wheel.bdist_wheel import bdist_wheel as _bdist_wheel
# @minecraft_build
class bdist_wheel(_bdist_wheel):
def finalize_options(self):
_bdist_wheel.finalize_options(self)
self.root_is_pure = False
except ImportError:
bdist_wheel = None
# https://github.com/chinmayshah99/PyDP/commit/2ddbf849a749adad5d5db10d4d7e3479567087f3
# Bug here https://github.com/python/cpython/blob/28ab3ce92402d86aa400960d38f0d69f498bb677/Lib/distutils/command/install.py#L335
# Original fix proposed here: https://github.com/google/or-tools/issues/616
class BinaryDistribution(Distribution):
"""This class is needed in order to create OS specific wheels."""
def has_ext_modules(self):
return True
def read(fname):
return open(os.path.join(os.path.dirname(__file__), fname)).read()
def unpack_assets():
asset_dir = os.path.join(os.path.expanduser('~'), '.gradle', 'caches', 'forge_gradle', 'assets')
output_dir = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'minerl', 'MCP-Reborn', 'src', 'main', 'resources')
index = load_asset_index(os.path.join(asset_dir, 'indexes', '1.16.json'))
unpack_assets_impl(index, asset_dir, output_dir)
def load_asset_index(index_file):
with open(index_file) as f:
return json.load(f)
def unpack_assets_impl(index, asset_dir, output_dir):
for k, v in index['objects'].items():
asset_hash = v["hash"]
src = os.path.join(asset_dir, 'objects', asset_hash[:2], asset_hash)
dst = os.path.join(output_dir, k)
os.makedirs(os.path.dirname(dst), exist_ok=True)
shutil.copy(src, dst)
class InstallPlatlib(install):
def finalize_options(self):
install.finalize_options(self)
# Hmm so this is wierd. When is has_ext_modules tru?
if self.distribution.has_ext_modules():
self.install_lib = self.install_platlib
class InstallWithMinecraftLib(install_lib):
"""Overrides the build command in install lib to build the minecraft library
and place it in the build directory.
"""
def build(self):
super().build()
class CustomBuild(build):
def run(self):
super().run()
class ShadowInplace(Command):
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
pass
def prep_mcp():
mydir = os.path.abspath(os.path.dirname(__file__))
# First, get MCP and patch it with our source.
if os.name == 'nt':
# Windows is picky about this, too... If you have WSL, you have
# bash command, but an absolute path won't work. So lets instead
# use relative paths
old_dir = os.getcwd()
os.chdir(os.path.join(mydir, 'scripts'))
try:
setup_output = subprocess.check_output(['bash.exe', 'setup_mcp.sh']).decode(errors="ignore")
if "ERROR: JAVA_HOME" in setup_output:
raise RuntimeError(
"""
`java` and/or `javac` commands were not found by the installation script.
Make sure you have installed Java JDK 8.
On Windows, if you installed WSL/WSL2, you may need to install JDK 8 in your WSL
environment with `sudo apt update; sudo apt install openjdk-8-jdk`.
"""
)
elif "Cannot lock task history" in setup_output:
raise RuntimeError(
"""
Installation failed probably due to Java processes dangling around from previous attempts.
Try killing all Java processes in Windows and WSL (if you use it). Rebooting machine
should also work.
"""
)
subprocess.check_call(['bash.exe', 'patch_mcp.sh'])
except subprocess.CalledProcessError as e:
raise RuntimeError(
"""
Running install scripts failed. Check error logs above for more information.
If errors are about `bash` command not found, You have at least two options to fix this:
1. Install Windows Subsystem for Linux (WSL. Tested on WSL 2). Note that installation with WSL
may seem especially slow/stuck, but it is not; it is just a bit slow.
2. Install bash along some other tools. E.g., git will come with bash: https://git-scm.com/downloads .
After installation, you may have to update environment variables to include a path which contains
'bash.exe'. For above git tools, this is [installation-dir]/bin.
After installation, you should have 'bash' command in your command line/powershell.
If errors are about "could not create work tree dir...", try cloning the MineRL repository
to a different location and try installation again.
"""
)
os.chdir(old_dir)
else:
subprocess.check_call(['bash', os.path.join(mydir, 'scripts', 'setup_mcp.sh')])
subprocess.check_call(['bash', os.path.join(mydir, 'scripts', 'patch_mcp.sh')])
# Next, move onto building the MCP source
gradlew = 'gradlew.bat' if os.name == 'nt' else './gradlew'
workdir = os.path.join(mydir, 'minerl', 'MCP-Reborn')
if os.name == 'nt':
# Windows is picky about being in the right directory to run gradle
old_dir = os.getcwd()
os.chdir(workdir)
# This may fail on the first try. Try few times
n_trials = 3
for i in range(n_trials):
try:
subprocess.check_call('{} downloadAssets'.format(gradlew).split(' '), cwd=workdir)
except subprocess.CalledProcessError as e:
if i == n_trials - 1:
raise e
else:
break
unpack_assets()
subprocess.check_call('{} clean build shadowJar'.format(gradlew).split(' '), cwd=workdir)
if os.name == 'nt':
os.chdir(old_dir)
# Don't build binaries (requires Java) on readthedocs.io server.
if os.environ.get("READTHEDOCS"):
print("READTHEDOCS env var is set; performing partial package install only.")
cmdclass = {}
else:
cmdclass = {
'bdist_wheel': bdist_wheel,
'install': InstallPlatlib,
'install_lib': InstallWithMinecraftLib,
'build_malmo': CustomBuild,
'shadow_develop': ShadowInplace,
}
prep_mcp()
setuptools.setup(
name='minerl',
version=os.environ.get('MINERL_BUILD_VERSION', '1.0.0'),
description='MineRL environment and data loader for reinforcement learning from human demonstration in Minecraft',
long_description=markdown,
long_description_content_type="text/markdown",
url='http://github.com/minerllabs/minerl',
author='MineRL Labs',
author_email='[email protected]',
license='MIT',
packages=setuptools.find_packages(exclude=['tests', 'tests.*']),
classifiers=[
"Programming Language :: Python :: 3",
"Operating System :: OS Independent",
],
install_requires=requirements,
distclass=BinaryDistribution,
include_package_data=True,
cmdclass=cmdclass,
)