Metadata-Version: 2.1
Name: venvipy
Version: 0.3.4
Summary: A GUI for managing Python virtual environments.
Home-page: https://github.com/sinusphi/venvipy
Author: Youssef Serestou
Author-email: sinusphi.sq@gmail.com
License: GPLv3+
Download-URL: https://github.com/sinusphi/venvipy/archive/v0.3.4.tar.gz
Keywords: python,python3,venv,virtualenvironment,virtual-environment,pyqt,pyqt5,pyqt5-desktop-application,gui
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: X11 Applications
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Other Audience
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: User Interfaces
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
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 :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE

.. image:: https://raw.githubusercontent.com/sinusphi/venvipy/main/img/cover_slim.png

**A GUI for managing multiple Python virtual environments**

.. image:: https://img.shields.io/badge/pypi-v0.3.4-blue?logo=pypi&logoColor=FFE873
    :target: https://pypi.org/project/venvipy/0.3.4/#description

.. image:: https://img.shields.io/badge/python-3.6+-blue?logo=python&logoColor=FFE873
    :target: https://www.python.org/downloads

.. image:: https://img.shields.io/badge/pyqt-5.15.4-darkgreen
    :target: https://pypi.org/project/PyQt5

.. image:: https://pepy.tech/badge/venvipy
    :target: https://pepy.tech/project/venvipy

.. image:: https://img.shields.io/badge/platform-linux-darkblue?logo=linux&logoColor=FFE873
    :target: https://www.linux.org/pages/download

.. image:: https://img.shields.io/badge/code%20style-black-000000
    :target: https://github.com/psf/black

.. image:: https://img.shields.io/badge/license-GPL%203.0-darkviolet
    :target: https://github.com/sinusphi/venvipy/blob/main/LICENSE

..
    .. image:: https://img.shields.io/travis/sinusphi/venvipy/main?label=Travis%20CI&logo=travis
        :target: https://travis-ci.org/sinusphi/venvipy

|

Introduction
------------

*VenviPy* is a graphical user interface for creating or modifing customized
virtual environments quick and easy. It was developed for \*NIX systems and
has been tested on various distributions.

*VenviPy* provides a set of features like a wizard, that guides the user through
the creation process, a table that shows an overview of installed
environments in a specific directory and a collection of context menu
actions like listing detailed information about an environment and much
more.

|

**The main menu:**

.. image:: https://raw.githubusercontent.com/sinusphi/venvipy/main/img/screen-1.png

|

**The wizard:**

.. image:: https://raw.githubusercontent.com/sinusphi/venvipy/main/img/screen-2.png

|

**Output when running pip commands:**

.. image:: https://raw.githubusercontent.com/sinusphi/venvipy/main/img/screen-3.png

|

Key Features
------------

*  Create virtual environments with any Python version (3.3+)
*  Clone an environment from a requirements file
*  Generate requirements from an existing environment
*  Add a description to an environment

|

*  Install and update Pip and Wheel with one click
*  Search and install packages from `PyPI <https://pypi.org/>`__
*  Install from requirements files
*  Install from local stored project directories
*  Install from a VCS project url *(currently git only)*
*  Install from local or remote source archives

|

*  List detailed information about installed packages
*  Show dependency tree (using
   `pipdeptree <https://pypi.org/project/pipdeptree/#description>`__ package)
*  Open a project's `PyPI <https://pypi.org/>`__ website in your browser

|

Prerequisits
------------

If you want to run *VenviPy* using your operating system's Python (3.6+)
you will have to make sure that the packages ``python3-venv`` and
``python3-pip`` are installed, because in this case the operating system's
venv and pip will be used to perform commands.

Also installing packages directly into your operating system's Python is
discouraged. If you want to do it anyway, you can do it like this:

.. code-block:: bash

    $ python3.x -m pip install venvipy

The better way however is to create a virtual environment and install
*VenviPy* into it:

.. code-block:: bash

    $ python3.x -m venv [your_venv]
    $ source [your_venv]/bin/activate

|

Installation
------------

To install the latest stable version of *VenviPy*:

.. code-block:: bash

    $ (your_venv) pip install venvipy

for the developement version:

.. code-block:: bash

    $ (your_venv) pip install git+https://github.com/sinusphi/venvipy.git

Now you can launch 

- the main menu via:

  - .. code-block:: bash

        $ (your_venv) venvipy

- or run the wizard standalone to quickly create and set up an environment:

  - .. code-block:: bash

        $ (your_venv) venvipy-wizard

|

Running from source
-------------------

Clone the repository (use the ``--depth`` option):

.. code-block:: bash

    $ (your_venv) git clone --depth 50 git@github.com:sinusphi/venvipy.git

Cd into the repo folder and install the dependencies. On Python 3.6 you will also
need to install the ``dataclasses`` package:

.. code-block:: bash

    $ (your_venv) pip install PyQt5==5.15.4 PyQt5-sip requests beautifoulsoup4

or from `requirements.txt <https://github.com/sinusphi/venvipy/blob/main/requirements.txt>`__:

.. code-block:: bash

    $ (your_venv) pip install -r requirements.txt

Then you can

- launch the main menu:

  - .. code-block:: bash
  
        $ (your_venv) python venvipy/venvi.py

- or run the wizard standalone to quickly create and set up an environment:

  - .. code-block:: bash

        $ (your_venv) python venvipy/wizard.py

|

Contributing
------------

Contributions are welcomed, as well as `Pull
requests <https://github.com/sinusphi/venvipy/pulls>`__, `bug
reports <https://github.com/sinusphi/venvipy/issues>`__, and `feature
requests <https://github.com/sinusphi/venvipy/issues>`__.


