{ "info": { "author": "R&T Equinor", "author_email": "", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Topic :: Multimedia :: Graphics", "Topic :: Scientific/Engineering", "Topic :: Scientific/Engineering :: Visualization" ], "description": "[![PyPI version](https://badge.fury.io/py/webviz-config.svg)](https://badge.fury.io/py/webviz-config)\n[![Build Status](https://travis-ci.org/equinor/webviz-config.svg?branch=master)](https://travis-ci.org/equinor/webviz-config)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1d7a659ea4784aa396ac1cb101c8e678)](https://www.codacy.com/manual/webviz/webviz-config?utm_source=github.com&utm_medium=referral&utm_content=equinor/webviz-config&utm_campaign=Badge_Grade)\n[![Python 3.6+](https://img.shields.io/badge/python-3.6+-blue.svg)](https://www.python.org/)\n![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)\n\n## Webviz configuration utility\n\n### Introduction\n\nWriting a Webviz application, built on top of [dash](https://github.com/plotly/dash),\ngives a lot of flexibility. However, it also requires Python knowledge from the\nperson setting it up.\n\nThis utility reduces the skills necessary to configure a Webviz application.\n\n*The workflow can be summarized as this:*\n1) The user provides a configuration file following the [yaml](https://en.wikipedia.org/wiki/YAML) standard.\n2) This utility reads the configuration file and automatically writes the corresponding Webviz Dash code.\n3) The created application can either be viewed locally, or deployed to a cloud provider. Both out of the box.\n\nCreating custom, specialized elements is possible. See the [contribution guide](./CONTRIBUTING.md) for\nmore details.\n\nThe [yaml](https://en.wikipedia.org/wiki/YAML) configuration file can either be\nmanually created, or it could be auto-generated by some other tool.\n\nExample configuration file and information about the standard containers\ncan be seen in [the documentation](https://equinor.github.io/webviz-config/).\n\n### Installation\n\nAs `dash` is using Python3-only functionality, you should use a Python3 (virtual)\nenvironment before installation. One way of doing this is\n```bash\nPATH_TO_VENV='./my_new_venv'\npython3 -m virtualenv $PATH_TO_VENV\nsource $PATH_TO_VENV/bin/activate\n```\n\nThe simplest way of installing `webviz-config` is to run\n```bash\npip install webviz-config\n```\n\nIf you want to download the latest source code and install it manually you \ncan run\n```bash\ngit clone git@github.com:equinor/webviz-config.git\ncd webviz-config\npip install .\n```\n\n### Run tests\n\nTo run tests it is necessary to first install [selenium chrome driver](https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver).\nThen install dev requirements and run pytest:\n\n```bash\npip install .[tests]\npip install dash[testing]\npytest tests --forked\n```\n\nThe second of these commands appears to be necessary as long as\n[this `pip` issue is open](https://github.com/pypa/pip/issues/4957).\n\nLinting can be checked by:\n\n```bash\nblack --check webviz_config tests\n```\n\n### Build documentation\n\nEnd-user documentation (i.e. YAML configuration file) be created\nafter installation by\n\n```bash\npip install .[tests]\ncd ./docs\npython3 build_docs.py\n```\n\nOfficially updated built end-user documentation (i.e. information to the\nperson setting up the configuration file) is\n[hosted here on github](https://equinor.github.io/webviz-config/).\n\n\n### Usage\n\nAfter installation, there is a console script named `webviz` available\nin `$PATH_TO_VENV/bin`. You can test the installation by using the provided test\nconfiguration file,\n```bash\nwebviz build ./examples/basic_example.yaml\n```\n\nWithout any additional arguments, this will\n1) create a temporary folder\n2) write the Webviz Dash application code to that folder\n3) start the server\n4) when stopping the server (press CTRL+C at any time), the temporary folder is deleted\n\nThe optional arguments can be seen when running\n```bash\nwebviz --help\n```\n\nFor example will\n```bash\nwebviz build ./examples/basic_example.yaml --portable /scratch/my_field/my_webviz\n```\ncreate a portable instance and store it in the provided folder.\n\nA recent feature in dash is [hot reload](https://community.plot.ly/t/announcing-hot-reload/14177).\nWhen the Dash Python code file is saved, the content seen in the web browser is\nautomatically reloaded (no need for server restart). This feature is passed on to\nWebviz configuration utility, meaning that if the user runs \n```bash\nwebviz build ./examples/basic_example.yaml\n```\nand then modifies `./examples/basic_example.yaml` while the Webviz application is\nstill running, a hot reload will occur.\n\nBy default `webviz-config` uses `https` and runs on `localhost`.\nIn order to create your personal `https` certificate (only valid for `localhost`), run\n```bash\nwebviz certificate --auto-install\n```\nCertificate installation guidelines will be given when running the command.\n\n### Creating new containers\n\nIf you are interested in creating new containers which can be configured through\nthe configuration file, take a look at the [contribution guide](./CONTRIBUTING.md).\n\n### Disclaimer\n\nThis is a tool under heavy development. The current configuration file layout\nwill therefore also see large changes.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/equinor/webviz-config", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "webviz-config", "package_url": "https://pypi.org/project/webviz-config/", "platform": "", "project_url": "https://pypi.org/project/webviz-config/", "project_urls": { "Homepage": "https://github.com/equinor/webviz-config" }, "release_url": "https://pypi.org/project/webviz-config/0.0.24/", "requires_dist": null, "requires_python": "", "summary": "Configuration file support for webviz", "version": "0.0.24" }, "last_serial": 5923640, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "750de9e1fe55b1ddb3a461bc1090d559", "sha256": "ab270666f2d46b7b7a8e1ec101cb6b101a819de56a1d2f8b253b6457a545de1a" }, "downloads": -1, "filename": "webviz-config-0.0.1.tar.gz", "has_sig": false, "md5_digest": "750de9e1fe55b1ddb3a461bc1090d559", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17116, "upload_time": "2019-03-29T17:04:47", "url": "https://files.pythonhosted.org/packages/a4/1c/abe6f15bf8ad1699e6f204ebe0a9ebc9174ca542a1d7d315a741bf4a37b8/webviz-config-0.0.1.tar.gz" } ], "0.0.10": [ { "comment_text": "", "digests": { "md5": "be49388d95bd949dae6d8d4faa759ca3", "sha256": "7d901361eb83105ea67203479e8e798135c8a3459f51f83e68ba3191bc244fc5" }, "downloads": -1, "filename": "webviz-config-0.0.10.tar.gz", "has_sig": false, "md5_digest": "be49388d95bd949dae6d8d4faa759ca3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 615268, "upload_time": "2019-06-19T09:33:05", "url": "https://files.pythonhosted.org/packages/36/60/926c83f69e743c682d40f196400d1f76a8c99f6740c5f42d609a46c50831/webviz-config-0.0.10.tar.gz" } ], "0.0.11": [ { "comment_text": "", "digests": { "md5": "392d8681c63faf25b036809675dc61ce", "sha256": "65bbe28afb47c507d5330b473bcb48cf5f1d6f4248cdc1be4a776e9242a01000" }, "downloads": -1, "filename": "webviz-config-0.0.11.tar.gz", "has_sig": false, "md5_digest": "392d8681c63faf25b036809675dc61ce", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 615266, "upload_time": "2019-06-19T19:13:21", "url": "https://files.pythonhosted.org/packages/31/da/bbbc9ca2a5f24326a68ed1812573a8874259f138046fa5479922fe3164fe/webviz-config-0.0.11.tar.gz" } ], "0.0.12": [ { "comment_text": "", "digests": { "md5": "b130f6cf97222f705c71330f4a18ddce", "sha256": "c538f9ce08336e697b871706db12bd3aeb307e56d1557e3868e9495228cc8d72" }, "downloads": -1, "filename": "webviz-config-0.0.12.tar.gz", "has_sig": false, "md5_digest": "b130f6cf97222f705c71330f4a18ddce", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 615873, "upload_time": "2019-06-25T09:38:40", "url": "https://files.pythonhosted.org/packages/b5/9d/a78d8d7905f3330296994fa8a3bab0040ba7aeb92206ea2ed94c70377df6/webviz-config-0.0.12.tar.gz" } ], "0.0.13": [ { "comment_text": "", "digests": { "md5": "54927bd87a73e7aebf3294ecce5eb923", "sha256": "87db24150c611189f6bee0df26067fc7da50ee992694a996b620714d2596f947" }, "downloads": -1, "filename": "webviz-config-0.0.13.tar.gz", "has_sig": false, "md5_digest": "54927bd87a73e7aebf3294ecce5eb923", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 616422, "upload_time": "2019-08-05T11:39:06", "url": "https://files.pythonhosted.org/packages/e2/af/53b4c49d6a072aed91ad7dda8d4d9ea347325da76245cd3e97b99eb8b6f8/webviz-config-0.0.13.tar.gz" } ], "0.0.14": [ { "comment_text": "", "digests": { "md5": "de85e6a266c25bddede4107c799b845e", "sha256": "ea043d678fdd5c33d6182563bb48076eca27c263abbd7ea8de768c8724ade614" }, "downloads": -1, "filename": "webviz-config-0.0.14.tar.gz", "has_sig": false, "md5_digest": "de85e6a266c25bddede4107c799b845e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 615515, "upload_time": "2019-08-20T09:31:48", "url": "https://files.pythonhosted.org/packages/90/8c/09b6b7500d2fa2046b724dcf144fcd2c05bb15e69d062e3b43892a9f971c/webviz-config-0.0.14.tar.gz" } ], "0.0.15": [ { "comment_text": "", "digests": { "md5": "d9b5eeda82062974859a636358f57137", "sha256": "3788b94b5871404014ffa8cc5b09c9d038696131137070554cf8b4817b820a5c" }, "downloads": -1, "filename": "webviz-config-0.0.15.tar.gz", "has_sig": false, "md5_digest": "d9b5eeda82062974859a636358f57137", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 615562, "upload_time": "2019-08-22T07:41:44", "url": "https://files.pythonhosted.org/packages/44/ed/2a7a83a9bb3c4954734a17648b791af69a1eda77c4f09910e30f73883c19/webviz-config-0.0.15.tar.gz" } ], "0.0.16": [ { "comment_text": "", "digests": { "md5": "67337f070b349ad53bd611df79bb5173", "sha256": "85f2a747361fd677b961e2765288c1d1ca43e8ff9bbcae2a0f3c37a1a6597d47" }, "downloads": -1, "filename": "webviz-config-0.0.16.tar.gz", "has_sig": false, "md5_digest": "67337f070b349ad53bd611df79bb5173", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 615925, "upload_time": "2019-08-28T12:56:08", "url": "https://files.pythonhosted.org/packages/4a/6b/80b85bc97dce55407cfb195935aab9c4fc886fc72bfede8cbfbc4411499b/webviz-config-0.0.16.tar.gz" } ], "0.0.17": [ { "comment_text": "", "digests": { "md5": "950c66f1a2abbd23729c776592a81f9b", "sha256": "346f94781d0edbaba338519f5d768207f8725c809a961dd0e8ae306be315b03d" }, "downloads": -1, "filename": "webviz-config-0.0.17.tar.gz", "has_sig": false, "md5_digest": "950c66f1a2abbd23729c776592a81f9b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 616834, "upload_time": "2019-08-30T13:55:51", "url": "https://files.pythonhosted.org/packages/0b/fb/f3f384f3bec9089742c8b9f3ece73da311368105f557aadd10dfc01d066b/webviz-config-0.0.17.tar.gz" } ], "0.0.18": [ { "comment_text": "", "digests": { "md5": "60f31eed57198aebfc0158a9f6610e46", "sha256": "a6c92e1c077cdf34c4d9027a2588e1bf0db43911c80aa4e14176bffc53977e6b" }, "downloads": -1, "filename": "webviz-config-0.0.18.tar.gz", "has_sig": false, "md5_digest": "60f31eed57198aebfc0158a9f6610e46", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 616904, "upload_time": "2019-09-04T09:21:39", "url": "https://files.pythonhosted.org/packages/d1/7b/ed34989019ddb5bf42bea3c884e680c9982f838f4a3d919131a6449cfec0/webviz-config-0.0.18.tar.gz" } ], "0.0.19": [ { "comment_text": "", "digests": { "md5": "c75b8dda7515f85589fb3e57d1e04f3d", "sha256": "caaa1d31d9257037d6457fd09a68c3b6234f324fc65391ce694c38261334c2b6" }, "downloads": -1, "filename": "webviz-config-0.0.19.tar.gz", "has_sig": false, "md5_digest": "c75b8dda7515f85589fb3e57d1e04f3d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 616918, "upload_time": "2019-09-21T19:53:25", "url": "https://files.pythonhosted.org/packages/be/e5/8da4bcd20543fc88ece50c6b91d8e60534a503df0094fcd7f5fc59bebd09/webviz-config-0.0.19.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "692cd6767e28441e11bde6c58d6ba23c", "sha256": "d10fb047266e8a23254ce6cf6991994ede7603290e2022bb11cb21b635257b6b" }, "downloads": -1, "filename": "webviz-config-0.0.2.tar.gz", "has_sig": false, "md5_digest": "692cd6767e28441e11bde6c58d6ba23c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 588470, "upload_time": "2019-04-04T14:10:00", "url": "https://files.pythonhosted.org/packages/c5/d7/1928e75d6ef8025a9b80bc5be126757c0da9d6e52496b2eede0f25e41386/webviz-config-0.0.2.tar.gz" } ], "0.0.20": [ { "comment_text": "", "digests": { "md5": "b1303f39b579a9310f6ccdd875c2a1f1", "sha256": "05a55a96938e0b69066103a556162280fbccb74f88f99e8c39c58e98eef4ebec" }, "downloads": -1, "filename": "webviz-config-0.0.20.tar.gz", "has_sig": false, "md5_digest": "b1303f39b579a9310f6ccdd875c2a1f1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 618698, "upload_time": "2019-09-23T19:19:15", "url": "https://files.pythonhosted.org/packages/da/fc/fb20889e0657972c1d84f08e325ade50969704732e9ba1f62edce32b1f1a/webviz-config-0.0.20.tar.gz" } ], "0.0.21": [ { "comment_text": "", "digests": { "md5": "c0a360e6b36d3b2068b56673a2b848e9", "sha256": "e609c65d33bda169529d3bb6a72f47e845325c456a776baf67b62063a54bf8a3" }, "downloads": -1, "filename": "webviz-config-0.0.21.tar.gz", "has_sig": false, "md5_digest": "c0a360e6b36d3b2068b56673a2b848e9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 618872, "upload_time": "2019-09-29T18:50:16", "url": "https://files.pythonhosted.org/packages/29/17/ef3b3d97257d9a66946aa107ac89134ede08b8ce0544ccde480d19fa1ebc/webviz-config-0.0.21.tar.gz" } ], "0.0.22": [ { "comment_text": "", "digests": { "md5": "f0a5765c95410e82d8713a9afb4a1ac4", "sha256": "1fd58c0661b5c7f12765b0c99bf3d4d46a927760dc7aaf2b5361cac902ec2b96" }, "downloads": -1, "filename": "webviz-config-0.0.22.tar.gz", "has_sig": false, "md5_digest": "f0a5765c95410e82d8713a9afb4a1ac4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 619344, "upload_time": "2019-09-30T19:30:42", "url": "https://files.pythonhosted.org/packages/14/32/ffb98c84bbb5854df0ee8bbd7703f83a4d0ca28069ebe46dcb78eb87b591/webviz-config-0.0.22.tar.gz" } ], "0.0.23": [ { "comment_text": "", "digests": { "md5": "13d60481f7421a4251b6e7ba14d951bc", "sha256": "a0b5f4278e0e644ce69290882a7a837f3ac11fa23a57aa2d11ac08deb1037894" }, "downloads": -1, "filename": "webviz-config-0.0.23.tar.gz", "has_sig": false, "md5_digest": "13d60481f7421a4251b6e7ba14d951bc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 619888, "upload_time": "2019-10-02T12:16:37", "url": "https://files.pythonhosted.org/packages/8f/cf/8b9f8188adda269f7acfb6380606c5f32bbdd9a00db96751bcc22c2c9d9f/webviz-config-0.0.23.tar.gz" } ], "0.0.24": [ { "comment_text": "", "digests": { "md5": "6b7c27acaba601ecd1cf928acee79a79", "sha256": "7535c0a446515bf0aa176cde1ea640d1db647f414080e88b342e46f95f8c8a98" }, "downloads": -1, "filename": "webviz-config-0.0.24.tar.gz", "has_sig": false, "md5_digest": "6b7c27acaba601ecd1cf928acee79a79", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 620392, "upload_time": "2019-10-03T14:02:20", "url": "https://files.pythonhosted.org/packages/16/ed/ed99233810f0c3eb94591e6d1c1bd6e1c0c96f9f5414b8e7e438729813d2/webviz-config-0.0.24.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "f70c30c13518f8ac32444aec8cbae24a", "sha256": "410931740507d0c7d326377939cade8a2aac4a49d5c0b0f3541eb069f12c43f2" }, "downloads": -1, "filename": "webviz-config-0.0.3.tar.gz", "has_sig": false, "md5_digest": "f70c30c13518f8ac32444aec8cbae24a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 591085, "upload_time": "2019-04-06T08:21:52", "url": "https://files.pythonhosted.org/packages/51/3f/39e36244ec9c2c7cc0449f1768f0194f9007653b6f3e033c6fd818eda9ae/webviz-config-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "200d8fe85c7314fb94f941c9dcb98e74", "sha256": "ddbb57be2aceab018d438c241692e00804b9fe727719ddca3ba500e21d07d8d8" }, "downloads": -1, "filename": "webviz-config-0.0.4.tar.gz", "has_sig": false, "md5_digest": "200d8fe85c7314fb94f941c9dcb98e74", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 600473, "upload_time": "2019-05-14T13:39:34", "url": "https://files.pythonhosted.org/packages/e1/8f/e701d8fa81e27b7775d319040f813040c94d86866d6ddfac9c2e6845ab31/webviz-config-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "7d4f568027180688c9a6f1ee187ccc9d", "sha256": "75443d8df57dfe87263a4b88554b31873aa22795e599d9b33f95a5b45858d315" }, "downloads": -1, "filename": "webviz-config-0.0.5.tar.gz", "has_sig": false, "md5_digest": "7d4f568027180688c9a6f1ee187ccc9d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 611780, "upload_time": "2019-05-20T11:58:24", "url": "https://files.pythonhosted.org/packages/2f/3a/bc06171a6175a548555407d7ec620db47f432ef37f804d8ff53fcf2891df/webviz-config-0.0.5.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "71281f8ad3f2d2df9eb6f8dcd68fad50", "sha256": "050beb8ed6e1543cd3b051f0482aa2bced6522863a3ae1f9c44c7bbef72476a2" }, "downloads": -1, "filename": "webviz-config-0.0.6.tar.gz", "has_sig": false, "md5_digest": "71281f8ad3f2d2df9eb6f8dcd68fad50", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 613228, "upload_time": "2019-05-28T06:53:11", "url": "https://files.pythonhosted.org/packages/a0/34/9906a84b9594e4b25629c5cc8ee4c7ebc2198abe772a32ac973f6317ad3d/webviz-config-0.0.6.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "520aaea9d8ace803a57e43a57f8b1a28", "sha256": "5cc07154c428d07f7b95e582bae6e93bc686132eb274b96ba3bd35cc1473bb7b" }, "downloads": -1, "filename": "webviz-config-0.0.7.tar.gz", "has_sig": false, "md5_digest": "520aaea9d8ace803a57e43a57f8b1a28", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 613230, "upload_time": "2019-05-29T12:16:30", "url": "https://files.pythonhosted.org/packages/8d/29/978d37a48b09337234c29c10ab4ae9e479ff1e5e0987ce21cfca4572285f/webviz-config-0.0.7.tar.gz" } ], "0.0.8": [ { "comment_text": "", "digests": { "md5": "d689653194d78531a73739c81609fe59", "sha256": "a7dd5f963a5fc9248186a9b6daca4bcaa42c9644d347941c0604acc643efc498" }, "downloads": -1, "filename": "webviz-config-0.0.8.tar.gz", "has_sig": false, "md5_digest": "d689653194d78531a73739c81609fe59", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 614987, "upload_time": "2019-06-04T13:17:29", "url": "https://files.pythonhosted.org/packages/40/7e/b281945cdda58f9c3d05a3ae3b2b0d6e27a8964c411cdbdaf420cf9fdca7/webviz-config-0.0.8.tar.gz" } ], "0.0.9": [ { "comment_text": "", "digests": { "md5": "e8f6bd126cb2b4d1b9b869effc8a269e", "sha256": "00a4b02a0e353d6418c903159bb63d5a27183a577791a1c87599d6e0f35d3b48" }, "downloads": -1, "filename": "webviz-config-0.0.9.tar.gz", "has_sig": false, "md5_digest": "e8f6bd126cb2b4d1b9b869effc8a269e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 615262, "upload_time": "2019-06-05T11:49:22", "url": "https://files.pythonhosted.org/packages/ca/8a/64bb96d14b35117e0f7428c46b61bac0472b96852eabdecfb554f7020169/webviz-config-0.0.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "6b7c27acaba601ecd1cf928acee79a79", "sha256": "7535c0a446515bf0aa176cde1ea640d1db647f414080e88b342e46f95f8c8a98" }, "downloads": -1, "filename": "webviz-config-0.0.24.tar.gz", "has_sig": false, "md5_digest": "6b7c27acaba601ecd1cf928acee79a79", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 620392, "upload_time": "2019-10-03T14:02:20", "url": "https://files.pythonhosted.org/packages/16/ed/ed99233810f0c3eb94591e6d1c1bd6e1c0c96f9f5414b8e7e438729813d2/webviz-config-0.0.24.tar.gz" } ] }