Metadata-Version: 2.1
Name: py2win
Version: 0.2.0
Summary: Create a stand-alone Windows distribution of a Python program
Home-page: https://github.com/ppinard/py2win
Author: Philippe T. Pinard
Author-email: philippe.pinard@gmail.com
License: MIT
Description: py2win
        ======
        
        .. image:: https://img.shields.io/pypi/v/py2win.svg
           :target: https://pypi.python.org/pypi/py2win
        
        .. image:: https://ci.appveyor.com/api/projects/status/github/ppinard/py2win?svg=true
           :target: https://ci.appveyor.com/project/ppinard/py2win
        
        Utility to create a stand-alone distribution of a Python program,
        either a console or GUI program.
        *py2win* uses `Python embedded distribution <https://docs.python.org/3.8/using/windows.html#embedded-distribution>`_
        and *pip* to create the stand-alone distribution.
        
        Installation
        ------------
        
        You need:
        
        * Python >= 3.6
        * Microsoft Visual Studio, compatible with your current Python installation
        
        Then simply run:
        
        .. code::
        
           pip install py2win
        
        How to use
        ------------
        
        As a command in ``setup.py``
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        1. Define at least one entry point in your ``setup.py``.
        
        .. code:: python
        
           setup(
                ...
                entry_points={
                    'gui_scripts': ['sample-gui=sample.gui:main'],
                    'console_scripts': ['sample-console=sample.console:main'],
                },
                ...
                )
        
        2. Run the ``bdist_windows`` command
        
        .. code::
        
           python setup.py --command-packages py2win bdist_windows
        
        As a separate script to create an embedded distribution
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        In a separate Python script (e.g. a ``release.py`` file in the root directory), you can define the embed process using the ``EmbedPython`` class and call the ``run`` method.
        
        .. code:: python
        
           from py2win.embed import EmbedPython
        
           embed = EmbedPython('sample', '1.2.0')
           embed.add_wheel(filepath_to_wheel_of_your_project)
           embed.add_requirement('PyQt5')
           embed.add_script(module='project.gui', method='main', executable_name='project-gui', console=False)
           embed.run(destination_directory)
        
        Release notes
        -------------
        
        0.2.0
        ^^^^^
        
        * Add support for arguments in console script (`PR#1 <https://github.com/ppinard/py2win/pull/1>`_)
        * Use `pathlib <https://docs.python.org/3/library/pathlib.html>`_ for paths
        * Use `pytest <https://pytest.org/en/latest/>`_ for tests
        * Use `black <https://github.com/psf/black>`_ for formatting
        
        0.1.0
        ^^^^^
        
        * First release
        
        Contributors
        ------------
        
        `@trollfred <https://github.com/trollfred>`_
        
        License
        -------
        
        The library is provided under the MIT license.
        
        Copyright (c) 2017-2019 Philippe Pinard
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Operating System :: Microsoft :: Windows
Classifier: Topic :: Software Development
Provides-Extra: dev
