Add developer guide to Holoviews documentation + consistency over all holoviz dev guides #4135
Comments
|
I'm also missing the developer guide. I just cloned the repo. What now? How should I install this? What should I do before opening a PR? |
|
I've followed the Panel developer guide to hopefully get a working developer environment. Log$ conda update -c pyviz pyctdev Collecting package metadata (current_repodata.json): done Solving environment: done ## Package Plan ## environment location: C:\Users\masma\Anaconda3 added / updated specs: - pyctdev The following packages will be downloaded: package | build ---------------------------|----------------- colorcet-3.0.0 | py_0 1.5 MB pyviz conda-package-handling-1.8.1| py38h8cc25b3_0 729 KB holoviews-1.14.9 | py_0 3.4 MB pyviz param-1.12.2 | py_0 95 KB pyviz tomli-2.0.1 | py38haa95532_0 25 KB ------------------------------------------------------------ Total: 5.8 MB The following NEW packages will be INSTALLED: pyct-core pyviz/noarch::pyct-core-0.4.8-py_0 The following packages will be UPDATED: colorcet pkgs/main::colorcet-2.0.6-pyhd3eb1b0_0 --> pyviz::colorcet-3.0.0-py_0 conda-package-han~ 1.7.3-py38h8cc25b3_1 --> 1.8.1-py38h8cc25b3_0 holoviews pkgs/main::holoviews-1.14.5-pyhd3eb1b~ --> pyviz::holoviews-1.14.9-py_0 param pkgs/main::param-1.11.1-pyhd3eb1b0_0 --> pyviz::param-1.12.2-py_0 tomli pkgs/main/noarch::tomli-1.2.2-pyhd3eb~ --> pkgs/main/win-64::tomli-2.0.1-py38haa95532_0 The following packages will be SUPERSEDED by a higher-priority channel: pyct pkgs/main/win-64::pyct-0.4.8-py38_0 --> pyviz/noarch::pyct-0.4.8-py_0 pyviz_comms pkgs/main::pyviz_comms-2.0.2-pyhd3eb1~ --> pyviz::pyviz_comms-0.7.6-py_0 Proceed ([y]/n)? y Downloading and Extracting Packages colorcet-3.0.0 | 1.5 MB | ################################### | 100% conda-package-handli | 729 KB | ################################### | 100% tomli-2.0.1 | 25 KB | ################################### | 100% holoviews-1.14.9 | 3.4 MB | ################################### | 100% param-1.12.2 | 95 KB | ################################### | 100% Preparing transaction: done Verifying transaction: done Executing transaction: done (base) MASMA@PC81978 MINGW64 /c/repos/private/holoviews (master) $ doit ecosystem_setup C:\Users\masma\Anaconda3\lib\site-packages\setuptools\distutils_patch.py:25: UserWarning: Distutils was imported before Setuptools. This usage is discouraged and may exhibit undesirable behaviors or errors. Please use Setuptools' objects directly or at least import Setuptools first. warnings.warn( . ecosystem_setup Collecting package metadata (current_repodata.json): ...working... done Solving environment: ...working... done ## Package Plan ## environment location: C:\Users\masma\Anaconda3 added / updated specs: - conda The following packages will be downloaded: package | build ---------------------------|----------------- colorcet-3.0.0 | py38haa95532_0 1.8 MB holoviews-1.14.8 | pyhd3eb1b0_0 3.2 MB param-1.12.0 | pyhd3eb1b0_0 75 KB pyct-0.4.8 | py38haa95532_1 45 KB ------------------------------------------------------------ Total: 5.2 MB The following packages will be REMOVED: pyct-core-0.4.8-py_0 The following packages will be UPDATED: pyct pyviz/noarch::pyct-0.4.8-py_0 --> pkgs/main/win-64::pyct-0.4.8-py38haa95532_1 pyviz_comms pyviz::pyviz_comms-0.7.6-py_0 --> pkgs/main::pyviz_comms-2.0.2-pyhd3eb1b0_0 The following packages will be SUPERSEDED by a higher-priority channel: colorcet pyviz/noarch::colorcet-3.0.0-py_0 --> pkgs/main/win-64::colorcet-3.0.0-py38haa95532_0 holoviews pyviz::holoviews-1.14.9-py_0 --> pkgs/main::holoviews-1.14.8-pyhd3eb1b0_0 param pyviz::param-1.12.2-py_0 --> pkgs/main::param-1.12.0-pyhd3eb1b0_0 Downloading and Extracting Packages param-1.12.0 | 75 KB | ########## | 100% colorcet-3.0.0 | 1.8 MB | ########## | 100% pyct-0.4.8 | 45 KB | ########## | 100% holoviews-1.14.8 | 3.2 MB | ########## | 100% Preparing transaction: ...working... done Verifying transaction: ...working... done Executing transaction: ...working... done Collecting package metadata (current_repodata.json): ...working... done Solving environment: ...working... done ## Package Plan ## environment location: C:\Users\masma\Anaconda3 added / updated specs: - anaconda-client - conda-build The following packages will be downloaded: package | build ---------------------------|----------------- conda-build-3.21.9 | py38haa95532_0 555 KB ------------------------------------------------------------ Total: 555 KB The following packages will be UPDATED: conda-build 3.21.5-py38haa95532_0 --> 3.21.9-py38haa95532_0 Downloading and Extracting Packages conda-build-3.21.9 | 555 KB | ########## | 100% Preparing transaction: ...working... done Verifying transaction: ...working... done Executing transaction: ...working... done (base) MASMA@PC81978 MINGW64 /c/repos/private/holoviews (master) $ doit env_create -c pyviz/label/dev -c conda-forge --name=holoviews_dev --python=3.9 C:\Users\masma\Anaconda3\lib\site-packages\setuptools\distutils_patch.py:25: UserWarning: Distutils was imported before Setuptools. This usage is discouraged and may exhibit undesirable behaviors or errors. Please use Setuptools' objects directly or at least import Setuptools first. warnings.warn( . env_create Collecting package metadata (current_repodata.json): ...working... done Solving environment: ...working... done ## Package Plan ## environment location: C:\Users\masma\Anaconda3\envs\holoviews_dev added / updated specs: - python=3.9 The following packages will be downloaded: package | build ---------------------------|----------------- ca-certificates-2022.6.15 | h5b45459_0 188 KB conda-forge libzlib-1.2.12 | h8ffe710_2 68 KB conda-forge openssl-3.0.5 | h8ffe710_0 7.6 MB conda-forge pip-22.2 | pyhd8ed1ab_0 1.5 MB conda-forge python-3.9.13 |hcf16a7b_0_cpython 17.9 MB conda-forge setuptools-63.2.0 | py39hcbf5309_0 1.3 MB conda-forge sqlite-3.39.2 | h8ffe710_0 1.3 MB conda-forge ------------------------------------------------------------ Total: 29.8 MB The following NEW packages will be INSTALLED: bzip2 conda-forge/win-64::bzip2-1.0.8-h8ffe710_4 ca-certificates conda-forge/win-64::ca-certificates-2022.6.15-h5b45459_0 libffi conda-forge/win-64::libffi-3.4.2-h8ffe710_5 libzlib conda-forge/win-64::libzlib-1.2.12-h8ffe710_2 openssl conda-forge/win-64::openssl-3.0.5-h8ffe710_0 pip conda-forge/noarch::pip-22.2-pyhd8ed1ab_0 python conda-forge/win-64::python-3.9.13-hcf16a7b_0_cpython python_abi conda-forge/win-64::python_abi-3.9-2_cp39 setuptools conda-forge/win-64::setuptools-63.2.0-py39hcbf5309_0 sqlite conda-forge/win-64::sqlite-3.39.2-h8ffe710_0 tk conda-forge/win-64::tk-8.6.12-h8ffe710_0 tzdata conda-forge/noarch::tzdata-2022a-h191b570_0 ucrt conda-forge/win-64::ucrt-10.0.20348.0-h57928b3_0 vc conda-forge/win-64::vc-14.2-hb210afc_6 vs2015_runtime conda-forge/win-64::vs2015_runtime-14.29.30037-h902a5da_6 wheel conda-forge/noarch::wheel-0.37.1-pyhd8ed1ab_0 xz conda-forge/win-64::xz-5.2.5-h62dcd97_1 Downloading and Extracting Packages python-3.9.13 | 17.9 MB | ########## | 100% sqlite-3.39.2 | 1.3 MB | ########## | 100% openssl-3.0.5 | 7.6 MB | ########## | 100% ca-certificates-2022 | 188 KB | ########## | 100% pip-22.2 | 1.5 MB | ########## | 100% setuptools-63.2.0 | 1.3 MB | ########## | 100% libzlib-1.2.12 | 68 KB | ########## | 100% Preparing transaction: ...working... done Verifying transaction: ...working... done Executing transaction: ...working... done # # To activate this environment, use # # $ conda activate holoviews_dev # # To deactivate an active environment, use # # $ conda deactivate Collecting package metadata (current_repodata.json): ...working... done Solving environment: ...working... failed with initial frozen solve. Retrying with flexible solve. Solving environment: ...working... failed with repodata from current_repodata.json, will retry with next repodata source. Collecting package metadata (repodata.json): ...working... done Solving environment: ...working... done ## Package Plan ## environment location: C:\Users\masma\Anaconda3\envs\holoviews_dev added / updated specs: - pyctdev The following packages will be downloaded: package | build ---------------------------|----------------- beautifulsoup4-4.11.1 | py39haa95532_0 190 KB ca-certificates-2022.07.19 | haa95532_0 123 KB certifi-2022.6.15 | py39haa95532_0 153 KB colorama-0.4.5 | py39haa95532_0 28 KB conda-4.13.0 | py39haa95532_0 923 KB conda-build-3.21.9 | py39haa95532_0 555 KB conda-package-handling-1.8.1| py39h8cc25b3_0 729 KB doit-0.33.1 | py39haa95532_0 142 KB menuinst-1.4.18 | py39h59b6b97_0 96 KB openssl-1.1.1q | h2bbff1b_0 4.8 MB pluggy-1.0.0 | py39haa95532_1 29 KB psutil-5.9.0 | py39h2bbff1b_0 349 KB py-lief-0.11.5 | py39hd77b12b_1 1.7 MB pycosat-0.6.3 | py39h2bbff1b_0 75 KB pywin32-302 | py39h2bbff1b_2 5.6 MB requests-2.28.1 | py39haa95532_0 99 KB ruamel_yaml-0.15.100 | py39h2bbff1b_0 273 KB tomli-2.0.1 | py39haa95532_0 25 KB ------------------------------------------------------------ Total: 15.9 MB The following NEW packages will be INSTALLED: beautifulsoup4 pkgs/main/win-64::beautifulsoup4-4.11.1-py39haa95532_0 brotlipy pkgs/main/win-64::brotlipy-0.7.0-py39h2bbff1b_1003 certifi pkgs/main/win-64::certifi-2022.6.15-py39haa95532_0 cffi pkgs/main/win-64::cffi-1.15.0-py39h2bbff1b_1 chardet pkgs/main/win-64::chardet-4.0.0-py39haa95532_1003 charset-normalizer pkgs/main/noarch::charset-normalizer-2.0.4-pyhd3eb1b0_0 cloudpickle pkgs/main/noarch::cloudpickle-2.0.0-pyhd3eb1b0_0 colorama pkgs/main/win-64::colorama-0.4.5-py39haa95532_0 conda pkgs/main/win-64::conda-4.13.0-py39haa95532_0 conda-build pkgs/main/win-64::conda-build-3.21.9-py39haa95532_0 conda-package-han~ pkgs/main/win-64::conda-package-handling-1.8.1-py39h8cc25b3_0 cryptography pkgs/main/win-64::cryptography-37.0.1-py39h21b164f_0 doit pkgs/main/win-64::doit-0.33.1-py39haa95532_0 filelock pkgs/main/noarch::filelock-3.6.0-pyhd3eb1b0_0 glob2 pkgs/main/noarch::glob2-0.7-pyhd3eb1b0_0 idna pkgs/main/noarch::idna-3.3-pyhd3eb1b0_0 jinja2 pkgs/main/noarch::jinja2-2.11.3-pyhd3eb1b0_0 libarchive pkgs/main/win-64::libarchive-3.5.2-h214662b_0 libiconv pkgs/main/win-64::libiconv-1.16-h2bbff1b_2 liblief pkgs/main/win-64::liblief-0.11.5-hd77b12b_1 libxml2 pkgs/main/win-64::libxml2-2.9.14-h0ad7f3c_0 lz4-c pkgs/main/win-64::lz4-c-1.9.3-h2bbff1b_1 markupsafe pkgs/main/win-64::markupsafe-2.0.1-py39h2bbff1b_0 menuinst pkgs/main/win-64::menuinst-1.4.18-py39h59b6b97_0 pkginfo pkgs/main/noarch::pkginfo-1.8.2-pyhd3eb1b0_0 pluggy pkgs/main/win-64::pluggy-1.0.0-py39haa95532_1 psutil pkgs/main/win-64::psutil-5.9.0-py39h2bbff1b_0 py pkgs/main/noarch::py-1.11.0-pyhd3eb1b0_0 py-lief pkgs/main/win-64::py-lief-0.11.5-py39hd77b12b_1 pycosat pkgs/main/win-64::pycosat-0.6.3-py39h2bbff1b_0 pycparser pkgs/main/noarch::pycparser-2.21-pyhd3eb1b0_0 pyctdev pyviz/noarch::pyctdev-0.7.0-py_0 pyopenssl pkgs/main/noarch::pyopenssl-22.0.0-pyhd3eb1b0_0 pysocks pkgs/main/win-64::pysocks-1.7.1-py39haa95532_0 python-libarchive~ pkgs/main/noarch::python-libarchive-c-2.9-pyhd3eb1b0_1 pytz pkgs/main/win-64::pytz-2022.1-py39haa95532_0 pywin32 pkgs/main/win-64::pywin32-302-py39h2bbff1b_2 pyyaml pkgs/main/win-64::pyyaml-6.0-py39h2bbff1b_1 requests pkgs/main/win-64::requests-2.28.1-py39haa95532_0 ruamel_yaml pkgs/main/win-64::ruamel_yaml-0.15.100-py39h2bbff1b_0 six pkgs/main/noarch::six-1.16.0-pyhd3eb1b0_1 soupsieve pkgs/main/noarch::soupsieve-2.3.1-pyhd3eb1b0_0 tomli pkgs/main/win-64::tomli-2.0.1-py39haa95532_0 tqdm pkgs/main/win-64::tqdm-4.64.0-py39haa95532_0 urllib3 pkgs/main/win-64::urllib3-1.26.9-py39haa95532_0 win_inet_pton pkgs/main/win-64::win_inet_pton-1.1.0-py39haa95532_0 wincertstore pkgs/main/win-64::wincertstore-0.2-py39haa95532_2 yaml pkgs/main/win-64::yaml-0.2.5-he774522_0 zlib pkgs/main/win-64::zlib-1.2.12-h8cc25b3_2 zstd pkgs/main/win-64::zstd-1.5.2-h19a0ad4_0 The following packages will be REMOVED: python_abi-3.9-2_cp39 The following packages will be UPDATED: ca-certificates conda-forge::ca-certificates-2022.6.1~ --> pkgs/main::ca-certificates-2022.07.19-haa95532_0 The following packages will be SUPERSEDED by a higher-priority channel: openssl conda-forge::openssl-3.0.5-h8ffe710_0 --> pkgs/main::openssl-1.1.1q-h2bbff1b_0 python conda-forge::python-3.9.13-hcf16a7b_0~ --> pkgs/main::python-3.9.12-h6244533_0 setuptools conda-forge::setuptools-63.2.0-py39hc~ --> pkgs/main::setuptools-61.2.0-py39haa95532_0 Downloading and Extracting Packages pywin32-302 | 5.6 MB | ########## | 100% ca-certificates-2022 | 123 KB | ########## | 100% psutil-5.9.0 | 349 KB | ########## | 100% menuinst-1.4.18 | 96 KB | ########## | 100% requests-2.28.1 | 99 KB | ########## | 100% tomli-2.0.1 | 25 KB | ########## | 100% conda-package-handli | 729 KB | ########## | 100% py-lief-0.11.5 | 1.7 MB | ########## | 100% certifi-2022.6.15 | 153 KB | ########## | 100% pluggy-1.0.0 | 29 KB | ########## | 100% conda-build-3.21.9 | 555 KB | ########## | 100% conda-4.13.0 | 923 KB | ########## | 100% colorama-0.4.5 | 28 KB | ########## | 100% doit-0.33.1 | 142 KB | ########## | 100% beautifulsoup4-4.11. | 190 KB | ########## | 100% pycosat-0.6.3 | 75 KB | ########## | 100% ruamel_yaml-0.15.100 | 273 KB | ########## | 100% openssl-1.1.1q | 4.8 MB | ########## | 100% Preparing transaction: ...working... done Verifying transaction: ...working... done Executing transaction: ...working... done (base) |
|
I'd like all HoloViz projects to point to a single developer guide at HoloViz.org for their main instructions, even if more complex projects like Panel need to add additional instructions. Certainly hvPlot and HoloViews should share a developer guide! |
There's no developer_guide in the docs for holoviews.
Can a developer guide be added for holoviews?
On panel there's a guide for how to start development:
https://hvplot.holoviz.org/developer_guide/index.html
And there's also one for hvplot:
https://hvplot.holoviz.org/developer_guide/index.html
Related issue: both existing guides suggest slightly different ways of working.
Can developer guides all be made in such a way that they are consistent over the whole holoviz ecosystem?
Another thing, somewhat related, is creating issues on holoviews, panel, hvplot etc.
In Holoviews I can just type away when creating an issue, but for hvplot and panel this is much more structured: you have to state whether it's a feature request or a bug and after that there's a template that reminds you to also state the holoviz versions you're using etc.
Holoviews is less structured for creating issues in comparison to hvplot and panel.
The text was updated successfully, but these errors were encountered: