diff --git a/README.rst b/README.rst index f2a2649..0df40d2 100644 --- a/README.rst +++ b/README.rst @@ -65,21 +65,22 @@ http://pymodes.readthedocs.io Install ------- -To install the latest version development from the GitHub: +The pyModeS can be installed with extra option ``[all]`` in order to install dependencies ``pyzmq`` and ``pyrtlsdr`` automatically. -:: - - pip install git+https://github.com/junzis/pyModeS - - -To install the latest stable version from pip: - -:: +Installation examples:: + # stable version, basic pip install pyModeS + # stable version, including dependencies for streamer and rtlsdr + pip install pyModeS[all] + + # development version, basic + pip install git+https://github.com/junzis/pyModeS + + # development version, including dependencies for streamer and rtlsdr + pip install git+https://github.com/junzis/pyModeS#egg=pyModeS[all] -The library requires several dependencies (``numpy``, ``pyzmq``, ``pyrtlsdr``), which will be installed automatically when you install pyModeS using ``pip``. View live traffic (modeslive) diff --git a/setup.py b/setup.py index 7b80193..6ae03cf 100644 --- a/setup.py +++ b/setup.py @@ -74,7 +74,7 @@ setup( # your project is installed. For an analysis of "install_requires" vs pip's # requirements files see: # https://packaging.python.org/en/latest/requirements.html - install_requires=["numpy", "argparse", "pyzmq", "pyrtlsdr"], + install_requires=["numpy"], # List additional groups of dependencies here (e.g. development # dependencies). You can install these using the following syntax, # for example: @@ -83,6 +83,7 @@ setup( # 'dev': ['check-manifest'], # 'test': ['coverage'], # }, + extras_require={"all": ["argparse", "pyzmq", "pyrtlsdr"]}, # If there are data files included in your packages that need to be # installed, specify them here. If using Python 2.6 or less, then these # have to be included in MANIFEST.in as well.