Skip to content

Commit

Permalink
Issue #29 - Add support for bliss-core install from PyPi
Browse files Browse the repository at this point in the history
- Update README documentation with info on how to specify additional
PyPi servers so bliss-core can be installed as part of the GUI
installation. The developer install instructions had to be reworked due
to issues with pip passing install-option's to dependencies as well as
the package to be installed. The current supported work around is a
horrible hack. See pypa/pip#1883 for info.
- Updated the bliss-core version to the latest release.
  • Loading branch information
MJJoyce committed Feb 28, 2017
1 parent 5302f83 commit 5d3efed
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,19 @@ BLISS GUI

Installation
------------
If you would like to install the UI for an end user you can skip all of the frontend dependency installation and install only the pre-bundled application. After cloning the repository, run the following from the project root:

`bliss-gui` depends upon `bliss-core` for key functionality. Ensure that you have followed the `bliss-core` installation procedure before progressing to the `bliss-gui` installation. You need to install `bliss-gui` into the same `virtualenv` environment into which you installed `bliss-core`. Be sure to have it activated while following these instructions.
```
pip install . --extra-index-url https://bliss.jpl.nasa.gov/pypi/simple/
```

If you would like to install the UI for an end user you can skip all of the frontend dependency installation and install only the pre-bundled application. After cloning the repository, run the following from the project root:
If you plan to do development work on the GUI you should install the repository in `develop` mode and install all of the dependencies necessary for a frontend build.

```
pip install .
pip install -e . --extra-index-url https://bliss.jpl.nasa.gov/pypi/simple && pip install -e . --no-deps --force-reinstall --upgrade --install-option="--with-ui-deps=True"
```

If you plan to do development work on the GUI you should install the repository in `develop` mode and install all of the dependencies necessary for a frontend build.
The above will install `bliss-core` for you. If you wish you can install `bliss-core` manually first and then install just the GUI with the below command. This allows you to have an editable checkout of `bliss-core` available for development.

```
pip install -e . --install-option="--with-ui-deps=True"
Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ def run(self):

develop.run(self)


class CustomInstallCmd(install):
user_options = install.user_options + [
('with-ui-deps=', None, "Toggle UI dependency installation")
Expand Down Expand Up @@ -69,7 +70,7 @@ def run(self):
include_package_data = True,

scripts = ['./bin/bliss_gui.py'],
install_requires = ['bliss-core>=0.8.0'],
install_requires = ['bliss-core>=0.10.0'],

cmdclass = {
"install": CustomInstallCmd,
Expand Down

0 comments on commit 5d3efed

Please sign in to comment.