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 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
|
import os
import sys
import platform
import json
import logging
from setuptools import setup, Command
from setuptools.command.egg_info import egg_info
from subprocess import check_call
# ensure the current directory is on sys.path; so versioneer can be imported
# when pip uses PEP 517/518 build rules.
# https://github.com/python-versioneer/python-versioneer/issues/193
sys.path.append(os.path.dirname(__file__))
import versioneer
here = os.path.dirname(os.path.abspath(__file__))
project_root = os.path.dirname(os.path.dirname(os.path.dirname(here)))
node_root = os.path.join(project_root, "packages", "javascript", "jupyterlab-plotly")
is_repo = os.path.exists(os.path.join(project_root, ".git"))
npm_path = os.pathsep.join(
[
os.path.join(node_root, "node_modules", ".bin"),
os.environ.get("PATH", os.defpath),
]
)
labstatic = "jupyterlab_plotly/labextension/static"
if not os.path.exists(labstatic):
# Ensure the folder exists when we will look for files in it
os.makedirs(labstatic)
prebuilt_assets = [
(
"share/jupyter/labextensions/jupyterlab-plotly",
[
"jupyterlab_plotly/labextension/package.json",
],
),
(
"share/jupyter/labextensions/jupyterlab-plotly/static",
[os.path.join(labstatic, f) for f in os.listdir(labstatic)],
),
(
"share/jupyter/nbextensions/jupyterlab-plotly",
[
"jupyterlab_plotly/nbextension/extension.js",
"jupyterlab_plotly/nbextension/index.js",
"jupyterlab_plotly/nbextension/index.js.LICENSE.txt",
],
),
]
if "--skip-npm" in sys.argv or os.environ.get("SKIP_NPM") is not None:
print("Skipping npm install as requested.")
skip_npm = True
if "--skip-npm" in sys.argv:
sys.argv.remove("--skip-npm")
else:
skip_npm = False
# Load plotly.js version from js/package.json
def plotly_js_version():
path = os.path.join(
project_root, "packages", "javascript", "jupyterlab-plotly", "package.json"
)
with open(path, "rt") as f:
package_json = json.load(f)
version = package_json["dependencies"]["plotly.js"]
version = version.replace("^", "")
return version
def readme():
with open(os.path.join(here, "README.md")) as f:
return f.read()
def js_prerelease(command, strict=False):
"""decorator for building minified js/css prior to another command"""
class DecoratedCommand(command):
def run(self):
jsdeps = self.distribution.get_command_obj("jsdeps")
if not is_repo and all(os.path.exists(t) for t in jsdeps.targets):
# sdist, nothing to do
command.run(self)
self.distribution.data_files.extend(prebuilt_assets)
return
try:
self.distribution.run_command("jsdeps")
except Exception as e:
missing = [t for t in jsdeps.targets if not os.path.exists(t)]
if strict or missing:
logging.warning("rebuilding js and css failed")
if missing:
logging.error("missing files: %s" % missing)
raise e
else:
logging.warning("rebuilding js and css failed (not a problem)")
logging.warning(str(e))
command.run(self)
update_package_data(self.distribution)
return DecoratedCommand
def update_package_data(distribution):
"""update package_data to catch changes during setup"""
build_py = distribution.get_command_obj("build_py")
# JS assets will not be present if we are skip npm build
if not skip_npm:
distribution.data_files.extend(prebuilt_assets)
# re-init build_py options which load package_data
build_py.finalize_options()
class NPM(Command):
description = "install package.json dependencies using npm"
user_options = []
node_modules = os.path.join(node_root, "node_modules")
targets = [
os.path.join(here, "jupyterlab_plotly", "nbextension", "extension.js"),
os.path.join(here, "jupyterlab_plotly", "nbextension", "index.js"),
os.path.join(here, "jupyterlab_plotly", "labextension", "package.json"),
]
def initialize_options(self):
pass
def finalize_options(self):
pass
def get_npm_name(self):
npmName = "npm"
if platform.system() == "Windows":
npmName = "npm.cmd"
return npmName
def has_npm(self):
npmName = self.get_npm_name()
try:
check_call([npmName, "--version"])
return True
except:
return False
def should_run_npm_install(self):
package_json = os.path.join(node_root, "package.json")
node_modules_exists = os.path.exists(self.node_modules)
return self.has_npm()
def run(self):
if skip_npm:
logging.info("Skipping npm-installation")
return
has_npm = self.has_npm()
if not has_npm:
logging.error(
"`npm` unavailable. If you're running this command using sudo, make sure `npm` is available to sudo"
)
env = os.environ.copy()
env["PATH"] = npm_path
if self.should_run_npm_install():
logging.info(
"Installing build dependencies with npm. This may take a while..."
)
npmName = self.get_npm_name()
check_call(
[npmName, "install"],
cwd=node_root,
stdout=sys.stdout,
stderr=sys.stderr,
)
check_call(
[npmName, "run", "build:prod"],
cwd=node_root,
stdout=sys.stdout,
stderr=sys.stderr,
)
os.utime(self.node_modules, None)
for t in self.targets:
if not os.path.exists(t):
msg = "Missing file: %s" % t
if not has_npm:
msg += "\nnpm is required to build a development version of jupyterlab-plotly"
raise ValueError(msg)
# update package data in case this created new files
update_package_data(self.distribution)
class CodegenCommand(Command):
description = "Generate class hierarchy from Plotly JSON schema"
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
if sys.version_info < (3, 8):
raise ImportError("Code generation must be executed with Python >= 3.8")
from codegen import perform_codegen
perform_codegen()
def overwrite_schema(url):
import requests
req = requests.get(url)
assert req.status_code == 200
path = os.path.join(here, "codegen", "resources", "plot-schema.json")
with open(path, "wb") as f:
f.write(req.content)
def overwrite_bundle(url):
import requests
req = requests.get(url)
assert req.status_code == 200
path = os.path.join(here, "plotly", "package_data", "plotly.js")
with open(path, "wb") as f:
f.write(req.content)
def overwrite_plotlyjs_version_file(plotlyjs_version):
path = os.path.join(here, "plotly", "offline", "_plotlyjs_version.py")
with open(path, "w") as f:
f.write(
"""\
# DO NOT EDIT
# This file is generated by the updatebundle setup.py command
__plotlyjs_version__ = "{plotlyjs_version}"
""".format(
plotlyjs_version=plotlyjs_version
)
)
def overwrite_plotlywidget_version_file(version):
path = os.path.join(here, "plotly", "_widget_version.py")
with open(path, "w") as f:
f.write(
"""\
# This file is generated by the updateplotlywidgetversion setup.py command
# for automated dev builds
#
# It is edited by hand prior to official releases
__frontend_version__ = "{version}"
""".format(
version=version
)
)
def request_json(url):
import requests
req = requests.get(url)
return json.loads(req.content.decode("utf-8"))
def get_latest_publish_build_info(repo, branch):
url = (
r"https://circleci.com/api/v1.1/project/github/"
r"{repo}/tree/{branch}?limit=100&filter=completed"
).format(repo=repo, branch=branch)
branch_jobs = request_json(url)
# Get most recent successful publish build for branch
builds = [
j
for j in branch_jobs
if j.get("workflows", {}).get("job_name", None) == "publish-dist"
and j.get("status", None) == "success"
]
build = builds[0]
# Extract build info
return {p: build[p] for p in ["vcs_revision", "build_num", "committer_date"]}
def get_bundle_schema_urls(build_num):
url = (
"https://circleci.com/api/v1.1/project/github/"
"plotly/plotly.js/{build_num}/artifacts"
).format(build_num=build_num)
artifacts = request_json(url)
# Find archive
archives = [a for a in artifacts if a.get("path", None) == "plotly.js.tgz"]
archive = archives[0]
# Find bundle
bundles = [a for a in artifacts if a.get("path", None) == "dist/plotly.min.js"]
bundle = bundles[0]
# Find schema
schemas = [a for a in artifacts if a.get("path", None) == "dist/plot-schema.json"]
schema = schemas[0]
return archive["url"], bundle["url"], schema["url"]
class UpdateSchemaCommand(Command):
description = "Download latest version of the plot-schema JSON file"
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
url = (
"https://raw.githubusercontent.com/plotly/plotly.js/"
"v%s/dist/plot-schema.json" % plotly_js_version()
)
overwrite_schema(url)
class UpdateBundleCommand(Command):
description = "Download latest version of the plot-schema JSON file"
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
url = (
"https://raw.githubusercontent.com/plotly/plotly.js/"
"v%s/dist/plotly.min.js" % plotly_js_version()
)
overwrite_bundle(url)
# Write plotly.js version file
plotlyjs_version = plotly_js_version()
overwrite_plotlyjs_version_file(plotlyjs_version)
class UpdatePlotlyJsCommand(Command):
description = "Update project to a new version of plotly.js"
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
self.run_command("updatebundle")
self.run_command("updateschema")
self.run_command("codegen")
class UpdateBundleSchemaDevCommand(Command):
description = "Update the plotly.js schema and bundle from master"
user_options = []
def initialize_options(self):
self.devrepo = None
self.devbranch = None
def finalize_options(self):
self.set_undefined_options("updateplotlyjsdev", ("devrepo", "devrepo"))
self.set_undefined_options("updateplotlyjsdev", ("devbranch", "devbranch"))
def run(self):
build_info = get_latest_publish_build_info(self.devrepo, self.devbranch)
archive_url, bundle_url, schema_url = get_bundle_schema_urls(
build_info["build_num"]
)
# Update bundle in package data
overwrite_bundle(bundle_url)
# Update schema in package data
overwrite_schema(schema_url)
# Update plotly.js url in package.json
package_json_path = os.path.join(node_root, "package.json")
with open(package_json_path, "r") as f:
package_json = json.load(f)
# Replace version with bundle url
package_json["dependencies"]["plotly.js"] = archive_url
with open(package_json_path, "w") as f:
json.dump(package_json, f, indent=2)
# update plotly.js version in _plotlyjs_version
rev = build_info["vcs_revision"]
date = str(build_info["committer_date"])
version = "_".join([self.devrepo, self.devbranch, date[:10], rev[:8]])
overwrite_plotlyjs_version_file(version)
class UpdatePlotlyJsDevCommand(Command):
description = "Update project to a new development version of plotly.js"
user_options = [
("devrepo=", None, "Repository name"),
("devbranch=", None, "branch or pull/number"),
]
def initialize_options(self):
self.devrepo = "plotly/plotly.js"
self.devbranch = "master"
def finalize_options(self):
pass
def run(self):
self.run_command("updatebundleschemadev")
self.run_command("jsdeps")
self.run_command("codegen")
class UpdatePlotlywidgetVersionCommand(Command):
description = "Update package.json version of jupyterlab-plotly"
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
from plotly._version import git_pieces_from_vcs, render
# Update plotly.js url in package.json
package_json_path = os.path.join(node_root, "package.json")
with open(package_json_path, "r") as f:
package_json = json.load(f)
# Replace version with bundle url
pieces = git_pieces_from_vcs("widget-v", project_root, False)
pieces["dirty"] = False
widget_ver = render(pieces, "pep440")["version"]
package_json["version"] = widget_ver
with open(package_json_path, "w") as f:
json.dump(package_json, f, indent=2)
# write _widget_version
overwrite_plotlywidget_version_file(widget_ver)
graph_objs_packages = [
d[0].replace("/", ".")
for d in os.walk("plotly/graph_objs")
if not d[0].endswith("__pycache__")
]
validator_packages = [
d[0].replace("/", ".")
for d in os.walk("plotly/validators")
if not d[0].endswith("__pycache__")
]
versioneer_cmds = versioneer.get_cmdclass()
setup(
name="plotly",
version=versioneer.get_version(),
author="Chris P",
author_email="chris@plot.ly",
maintainer="Nicolas Kruchten",
maintainer_email="nicolas@plot.ly",
url="https://plotly.com/python/",
project_urls={"Github": "https://github.com/plotly/plotly.py"},
description="An open-source, interactive data visualization library for Python",
long_description=readme(),
long_description_content_type="text/markdown",
classifiers=[
"Development Status :: 5 - Production/Stable",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Topic :: Scientific/Engineering :: Visualization",
"License :: OSI Approved :: MIT License",
],
python_requires=">=3.8",
license="MIT",
packages=[
"jupyterlab_plotly",
"plotly",
"plotly.plotly",
"plotly.offline",
"plotly.io",
"plotly.matplotlylib",
"plotly.matplotlylib.mplexporter",
"plotly.matplotlylib.mplexporter.renderers",
"plotly.figure_factory",
"plotly.data",
"plotly.colors",
"plotly.express",
"plotly.express.data",
"plotly.express.colors",
"plotly.express.trendline_functions",
"plotly.graph_objects",
"_plotly_utils",
"_plotly_utils.colors",
"_plotly_future_",
]
+ graph_objs_packages
+ validator_packages,
zip_safe=False,
)
|