Metadata-Version: 2.1
Name: installer
Version: 0.1.1
Summary: A library for installing python packages.
Home-page: https://github.com/sarugaku/installer
Author: Dan Ryan and Tzu-ping Chung
Author-email: dan@danryan.co
License: ISC License
Keywords: package management,resolver,pipenv,requirementslib,pipfile,dependencies,dependency management,package installer,package installation
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=2.6,!=3.0,!=3.1,!=3.2,!=3.3
Provides-Extra: virtualenv
Provides-Extra: tests
Requires-Dist: distlib
Requires-Dist: packaging
Requires-Dist: packagebuilder
Requires-Dist: pip-shims
Requires-Dist: requirementslib
Requires-Dist: setuptools
Requires-Dist: vistir[spinner]
Provides-Extra: tests
Requires-Dist: pytest-timeout; extra == 'tests'
Requires-Dist: pytest-xdist; extra == 'tests'
Requires-Dist: pytest-cov; extra == 'tests'
Requires-Dist: pytest; extra == 'tests'
Provides-Extra: virtualenv
Requires-Dist: mork; extra == 'virtualenv'
Requires-Dist: virtualenv; extra == 'virtualenv'

===============================================================================
installer: A library for installing python packages.
===============================================================================

.. image:: https://img.shields.io/pypi/v/installer.svg
    :target: https://pypi.org/project/installer

.. image:: https://img.shields.io/pypi/l/installer.svg
    :target: https://pypi.org/project/installer

.. image:: https://api.travis-ci.com/sarugaku/installer.svg?branch=master
    :target: https://travis-ci.com/sarugaku/installer

.. image:: https://ci.appveyor.com/api/projects/status/y9kpdaqy4di5nhyk/branch/master?svg=true
    :target: https://ci.appveyor.com/project/sarugaku/installer

.. image:: https://img.shields.io/pypi/pyversions/installer.svg
    :target: https://pypi.org/project/installer

.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
    :target: https://saythanks.io/to/techalchemy

.. image:: https://readthedocs.org/projects/installer/badge/?version=latest
    :target: https://installer.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status


Summary
=======

Installer_ is a library designed for installing python packages built using packagebuilder_.
It is targeted as a lightweight library for synchronizing Pipfile_ formatted projects with
their respective environments (but provides no interface through virtual environments,
see mork_ for that!).  Its goal is to provide a small but functional interface to take a
set of requirementslib_ compatible requirements (preferrably from a `Pipfile.lock`) and
install them into an environment, optionally removing packages not present in the lockfile.

Ultimately this project will back installation in Pipenv_.

  ::

    >>> import installer
    >>> from passa.cli.options import Project
    >>> project = Project(root="/some/root/directory")
    >>> syncer = installer.synchronizer.Synchronizer(
        project, default=True, develop=True,
        clean_unneeded=True
    )
    >>> installer.operations.sync(syncer)


.. _packagebuilder: https://github.com/sarugaku/packagebuilder
.. _requirementslib: https://github.com/sarugaku/requirementslib
.. _mork: https://github.com/sarugaku/mork
.. _pipfile: https://github.com/pypa/pipfile
.. _pipenv: https://github.com/pypa/pipenv

`Read the documentation <https://installer.readthedocs.io/>`__.


