Metadata-Version: 1.1
Name: opx
Version: 1.0.1
Summary: OpenSwitch Development Tool
Home-page: https://github.com/open-switch/tools_opx-py
Author: Tyler Heucke
Author-email: tyler.heucke@dell.com
License: MIT
Description: OpenSwitch Development Tool
        ===========================
        
        .. image:: https://img.shields.io/pypi/v/opx.svg
            :target: https://pypi.python.org/pypi/opx
        
        .. image:: https://img.shields.io/pypi/l/opx.svg
            :target: https://pypi.python.org/pypi/opx
        
        .. image:: https://img.shields.io/pypi/pyversions/opx.svg
            :target: https://pypi.python.org/pypi/opx
        
        .. image:: https://readthedocs.org/projects/opx/badge/?version=latest
            :target: https://opx.readthedocs.io
        
        Installation
        ------------
        
        .. code-block:: bash
        
            $ pip3 install opx
        
        Requirements
        ~~~~~~~~~~~~
        
        - `Docker <https://docs.docker.com/engine/installation/>`_
        - `Git <https://git-scm.com/>`_
        - `Repo <https://source.android.com/setup/downloading#installing-repo>`_
        
        Getting Started
        ---------------
        
        .. code-block:: bash
        
            # initialize your workspace
            $ opx init
        
            # build all packages
            $ opx build
        
            # assemble an installer
            $ opx assemble
        
            # remove persistent container
            $ opx remove
        
        New Features (Over `opx-build <https://github.com/open-switch/opx-build>`_)
        ---------------------------------------------------------------------------
        
        * Opinionated defaults
            * Remembers to pull Docker image regularly so you don't have to
            * Sort packages into ``pkg/$repo/`` after building
            * Persistent container (if inside a workspace)
            * One container allowed per workspace
        
        * Publish packages to testing
        
        .. code-block:: bash
        
            $ opx publish opx-logging
        
        * Commands are aliased
        
        .. code-block:: bash
        
            # all run opx build
            $ opx b opx-logging
            $ opx bui opx-logging
            $ opx build opx-logging
        
        
        Command Line Completion
        -----------------------
        
        Run the command corresponding with your shell. Add to your shell startup file for persistent autocomplete.
        
        .. code-block:: bash
        
            # bash
            $ eval "$(_OPX_COMPLETE=source-bash opx)"
        
            # zsh
            $ eval "$(_OPX_COMPLETE=source-zsh opx)"
        
            # fish
            $ eval (env _OPX_COMPLETE=source-fish opx)
        
        Roadmap
        -------
        
        * Port ``opx_rel_pkgasm`` from python script to module
        * Port ``opx_get_packages`` from python script to module
        * Port ``opx_bld_basics`` from python script to module
        
        License
        -------
        
        OpenSwitch Development Tool is distributed under the terms of the
        `MIT License <https://choosealicense.com/licenses/mit>`_.
        
Keywords: openswitch,opx
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
