Skip to content

Commit

Permalink
Clarify developer installation instructions, and fix up some metadata. (
Browse files Browse the repository at this point in the history
  • Loading branch information
ceball authored and philippjfr committed Jan 22, 2020
1 parent 82f5514 commit be06df4
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 43 deletions.
1 change: 0 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,6 @@ jobs:
- source activate test-environment
- doit develop_install $CHANS_DEV -o build && pip uninstall -y panel
- doit pip_on_conda
- conda install $CHANS_DEV nodejs
- doit ecosystem=pip package_build $PKG_TEST_PYTHON --test-group=unit_deploy
script: doit ecosystem=pip package_upload -u $PYPIUSER -p $PYPIPASS --pypi ${PYPI}

Expand Down
8 changes: 4 additions & 4 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2018, PyViz contributors (pyviz.org)
Copyright (c) 2018-2020, HoloViz team (holoviz.org).
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand All @@ -13,9 +13,9 @@ met:
documentation and/or other materials provided with the
distribution.

* Neither the name of PyViz nor the names of its contributors
may be used to endorse or promote products derived from this
software without specific prior written permission.
* Neither the name of the copyright holder nor the names of any
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Expand Down
51 changes: 21 additions & 30 deletions doc/developer_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,16 +57,9 @@ This will create a ``panel`` directory at your file system
location. This ``panel`` directory is referred to as the *source
checkout* for the remainder of this document.

.. _dev_guide_installing_dependencies:

Installing Dependencies
-----------------------

Panel requires many additional packages for development and
testing. Many of these are on the main Anaconda default channel.

Conda Environments
~~~~~~~~~~~~~~~~~~
Create a development environment
--------------------------------

Since Panel interfaces with a large range of different libraries the
full test suite requires a wide range of dependencies. To make it
Expand Down Expand Up @@ -96,41 +89,38 @@ created you can activate it with:
conda activate panel_dev
Finally to install the dependencies required to run the full unit test
suite:

.. code-block:: sh
doit develop_install -c pyviz/label/dev -c conda-forge -c bokeh -o tests -o recommended
.. _devguide_python_setup:

Building and Installing
-----------------------
Install Panel in editable mode
------------------------------

To perform an editable install of Panel, including all the
dependencies required to run the full unit test suite, run the
following:

Once you have all the required depencies installed, the simplest way
to build and install Panel to use the ``setup.py`` script at the top
level of the *source checkout* directory.
.. code-block:: sh
The ``setup.py`` script has two main modes of operation:
doit develop_install -c pyviz/label/dev -c conda-forge -c bokeh -o build -o tests -o recommended
``python setup.py install``
The above command installs Panel's dependencies using conda, then
performs a pip editable install of Panel.

Panel will be installed in your Python ``site-packages`` directory.
In this mode, any changes to the python source code will not show up
until ``setup.py install`` is run again.

``python setup.py develop``
Developing custom models
------------------------

Panel will be installed to refer to the source directory. Any changes
you make to the python source code will be available immediately without
any additional steps.
If you are adding or editing a bokeh model, you can use `panel build
panel` to build the javascript. The `build` command is just an alias
for `bokeh build`; see the `Bokeh developer guide`_ for more
information about developing bokeh models.


Next Steps
----------

If you have any problems with the steps here, please `contact the developers`_.
You will likely want to check out the :ref:`devguide_testing` guide. Meanwhile,
if you have any problems with the steps here, please `contact the developers`_.

.. _Anaconda: https://anaconda.com/downloads
.. _contact the developers: https://gitter.im/pyviz/pyviz
Expand All @@ -141,6 +131,7 @@ If you have any problems with the steps here, please `contact the developers`_.
.. _GitHub: https://github.com
.. _Installing Git: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
.. _Pro Git Book: https://git-scm.com/book/en/v2
.. _Bokeh developer guide: https://docs.bokeh.org/en/latest/docs/dev_guide/setup.html


.. toctree::
Expand Down
3 changes: 2 additions & 1 deletion postBuild
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
bokeh sampledata
# this file is used by binder
bokeh sampledata
13 changes: 6 additions & 7 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,6 @@ def run(self):
'scikit-learn',
'datashader',
'jupyter_bokeh',
'nodejs'
],
'recommended': _recommended,
'doc': _recommended + [
Expand Down Expand Up @@ -154,16 +153,16 @@ def run(self):
setup_args = dict(
name='panel',
version=get_setup_version("panel"),
description='A high level dashboarding library for python visualization libraries.',
description='A high level app and dashboarding solution for Python.',
long_description=open('README.md').read() if os.path.isfile('README.md') else 'Consult README.md',
long_description_content_type="text/markdown",
author="PyViz developers",
author_email="developers@pyviz.org",
maintainer="PyViz",
maintainer_email="developers@pyviz.org",
author="HoloViz",
author_email="developers@holoviz.org",
maintainer="HoloViz",
maintainer_email="developers@holoviz.org",
platforms=['Windows', 'Mac OS X', 'Linux'],
license='BSD',
url='http://pyviz.org',
url='http://panel.holoviz.org',
cmdclass=_COMMANDS,
packages=find_packages(),
include_package_data=True,
Expand Down

0 comments on commit be06df4

Please sign in to comment.