Metadata-Version: 1.2
Name: pipm
Version: 0.8
Summary: Wrapper around pip commands to auto save/delete requirements
Home-page: https://github.com/jnoortheen/pipm
Author: noortheen
Author-email: jnoortheen@gmail.com
License: MIT
Description: 
        pipm
        ====
        
        Python package management workflow using pip & requirements file as its metadata. (For the time being until ``Pipfile`` 
        is mature enough or the ``pipenv`` is fast enough to use.)
        
        Installation
        ============
        
        Install from PyPI
        
        .. code-block::
        
           pip install pipm
        
        Or Install directly from the GitHub
        
        .. code-block:: commandline
        
           pip install -e git://github.com/jnoortheen/pipm.git@master#egg=pipm
        
        Quickstart
        ==========
        
        All ``pip`` commands will work as it is, plus they will be saved to the requirements file.
        
        installation
        ^^^^^^^^^^^^
        
        ``pipm install pkg-name``
        
        installation as development dependency
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        ``pipm install pkg-name --dev``
        
        installation as testing dependency
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        ``pipm install pkg-name --test``
        
        removal
        ^^^^^^^
        
        ``pipm uninstall pkg-name``
        
        update all your dependencies
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        ``pipm update``
        
        install all your dependencies from the requirements file
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        ``pipm install``
        
        including development dependencies
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        ``pipm install --dev``
        
        Usage
        =====
        
        
        #. 
           install
        
        
           * 
             a wrapper around standard ``pip install`` command and accepts all the standard options
        
             Below are the things that ``pipm`` brings to the table
        
           * 
             Extra functionality
        
        
             * when package names are given it will be saved to the requirements.txt file in the current directory.
               If you have ``requirements`` directory structure with ``base.txt`` inside then that file will be used. Otherwise it 
               will create one in the current directory.
             * when no package name is given then it is equivalent to ``-r requirements.txt`` and it will install all requirements
               from the current directory
        
           * Additions options:
              the below saves to file when package name given otherwise equivalent to passing requirements file name.
        
             #. ``--dev`` - saves to development requirements
             #. ``--prod`` - saves to production requirements
             #. ``--test`` - saves to  testing requirements
             #. ``--env <name>`` - if you have any special set of requirements that belong to a separate file you could pass the name here.
                It will search for the matching one in the following pattern ``<name>-requirements.txt`` or 
                ``requirements/<name>.txt`` or ``requirements-<name>.txt``
        
        #. 
           uninstall 
        
        
           * a wrapper around standard ``pip uninstall`` command
           * alias ``rm`` is available
           * when uninstalling a package, this command also checks packages that are no longer required by any of the installed
             packages and removes them
           * ofcourse it removes the packages from ``requirements`` files
        
        #. 
           update
        
        
           * new command
           * equivalent to calling ``pip install`` with ``--upgrade`` flag
           * update a single package or the whole environment when no argument given.
        
        #. 
           save/freeze
        
        
           * extends the standard freeze command to save the currently installed packages
        
        Features
        ========
        
        
        #. Just a wrapper around the standard pip's ``install`` & ``uninstall`` command. So all the cli options will work
        #. Handles multiple ``requirements`` files
        
        Testing
        =======
        
        
        * After installing ``requirements`` just run ``invoke test`` from the root directory.
        
        ``Note``\ : last tested with pip 9.0.1
        
Keywords: easy_install distutils setuptools egg virtualenv requirements
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Build Tools
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*
