Merge branch 'release-0.0.6'

Author: sinoroc

.gitlab-ci.yml

@@ -1,23 +1,24 @@
 ---
 
 
-'.test_common': &job_test_common
+'.review':
   script:
+    - 'export TOXENV="${CI_JOB_NAME##review}"'
     - 'python3 -m pip install tox'
     - 'python3 -m tox'
     - 'python3 -m tox -e package'
 
-'test py36':
-  <<: *job_test_common
+'review py36':
+  extends: '.review'
   image: 'python:3.6'
-  variables:
-    'TOXENV': 'py36'
 
-'test py37':
-  <<: *job_test_common
+'review py37':
+  extends: '.review'
   image: 'python:3.7'
-  variables:
-    'TOXENV': 'py37'
+
+'review py38':
+  extends: '.review'
+  image: 'python:3.8'
 
 
 ... EOF

.travis.yml

@@ -8,6 +8,7 @@ language: 'python'
 python:
   - '3.6'
   - '3.7'
+  - '3.8'
 
 install:
   - 'python3 -m pip install tox tox-travis tox-venv'

CHANGELOG.rst

@@ -2,6 +2,14 @@
 
 
 .. Keep the current version number on line number 5
+0.0.6
+=====
+
+2020-03-30
+
+* Add support for 'requirements.txt' files
+
+
 0.0.5
 =====
 

README.rst

@@ -4,13 +4,13 @@
 Introduction
 ============
 
-Build ``zipapp`` single file Python applications easily.
+Build `zipapp`_ (`PEP 441`_) single file Python applications easily.
 
 
 Repositories
 ------------
 
-Binary distributions:
+Distributions:
 
 * https://pypi.org/project/zapp/
 
@@ -26,9 +26,26 @@ Usage
 Standalone application
 ----------------------
 
+.. code::
+
+    usage: zapp [-h] [--version] [--requirement requirements.txt]
+                output_file entry_point [requirement [requirement ...]]
+
+    positional arguments:
+      output_file
+      entry_point
+      requirement
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      --version             show program's version number and exit
+      --requirement requirements.txt, -r requirements.txt
+
+
 .. code::
 
     zapp ~/bin/myapp myapp.cli:main 'myapp==1.2.3' 'mylib==3.2.1'
+    zapp ~/bin/myapp myapp.cli:main --requirement requirements.txt
 
     python3 -m zapp ~/bin/myapp myapp.cli:main 'myapp==1.2.3' 'mylib==3.2.1'
 
@@ -48,12 +65,13 @@ Library
     import zapp
 
     zapp.core.build_zapp(
-        [
+        'myapp.pyz',  # output_file
+        'myapp.cli:main',  # entry_point
+        requirements=[
             'myapp==1.2.3',
             'mylib==3.2.1',
         ],
-        'myapp.cli:main',
-        'myapp.pyz',
+        requirements_txt='requirements.txt',
     )
 
 
@@ -80,7 +98,9 @@ Similar applications
 
 .. _`shiv`: https://pypi.org/project/shiv/
 .. _`pex`: https://pypi.org/project/pex/
+.. _`PEP 441`: https://www.python.org/dev/peps/pep-0441/
 .. _`superzippy`: https://pypi.org/project/superzippy/
+.. _`zipapp`: https://docs.python.org/3/library/zipapp.html
 
 
 .. EOF

src/zapp/cli.py

@@ -20,8 +20,20 @@ def main():
     parser.add_argument('output_file')
     parser.add_argument('entry_point')
     parser.add_argument('requirements', metavar='requirement', nargs='*')
+    parser.add_argument(
+        '--requirement',
+        '-r',
+        dest='requirements_txt',
+        metavar='requirements.txt',
+        type=argparse.FileType(),
+    )
     args = parser.parse_args()
-    core.build_zapp(args.requirements, args.entry_point, args.output_file)
+    core.build_zapp(
+        args.output_file,
+        args.entry_point,
+        args.requirements,
+        getattr(args.requirements_txt, 'name', None),
+    )
 
 
 # EOF

src/zapp/core.py

@@ -14,6 +14,14 @@
 import setuptools
 
 
+class ZappException(Exception):
+    """Base exception class"""
+
+
+class BdistWheelMissing(ZappException):
+    """The 'setuptools' command 'bdist_wheel' can not be found"""
+
+
 class _EnvBuilder(venv.EnvBuilder):
 
     def __init__(self, *args, **kwargs):
@@ -32,27 +40,40 @@ def _venv_create(venv_dir):
     return venv_context
 
 
-def _pip_install(venv_context, requirements, target_dir=None):
+def _pip_install(
+        venv_context,
+        requirements=None,
+        requirements_txt=None,
+        target_dir=None,
+):
     command = [
         venv_context.env_exe,
         '-m', 'pip',
         'install',
     ]
     if target_dir:
         command.extend(['--target', target_dir])
-    command.extend(requirements)
+    if requirements:
+        command.extend(requirements)
+    if requirements_txt:
+        command.extend(['--requirement', requirements_txt])
     subprocess.check_call(command)
 
 
-def _install_to_dir(target_dir, requirements):
+def _install_to_dir(target_dir, requirements=None, requirements_txt=None):
     """ Use pip to install the requirements into a specific directory
     """
     # pip is not usable as a library, so it is much simpler and safer to just
     # create a virtual environment and run a pip process from there
     with tempfile.TemporaryDirectory() as venv_dir:
         venv_context = _venv_create(venv_dir)
         _pip_install(venv_context, ['wheel'])
-        _pip_install(venv_context, requirements, target_dir)
+        _pip_install(
+            venv_context,
+            requirements=requirements,
+            requirements_txt=requirements_txt,
+            target_dir=target_dir,
+        )
 
 
 def _create_zipapp_archive(source_dir, entry_point, output_file):
@@ -64,12 +85,21 @@ def _create_zipapp_archive(source_dir, entry_point, output_file):
     )
 
 
-def build_zapp(requirements, entry_point, output_file):
+def build_zapp(
+        output_file,
+        entry_point,
+        requirements=None,
+        requirements_txt=None,
+):
     """ Build a zapp binary archive
     """
     with tempfile.TemporaryDirectory() as install_dir:
-        if requirements:
-            _install_to_dir(install_dir, requirements)
+        if requirements or requirements_txt:
+            _install_to_dir(
+                install_dir,
+                requirements=requirements,
+                requirements_txt=requirements_txt,
+            )
         _create_zipapp_archive(install_dir, entry_point, output_file)
 
 
@@ -164,9 +194,7 @@ def run(self):
                 if dist[0] == 'bdist_wheel':
                     dist_file = dist[2]
             if not dist_file:
-                raise distutils.errors.DistutilsInternalError(
-                    "can not find bdist_wheel",
-                )
+                raise BdistWheelMissing()
             _install_to_dir(self.bdist_dir, [dist_file])
             self.mkpath(self.dist_dir)
             _create_zipapp_archive(

tox.ini

@@ -11,6 +11,7 @@ requires =
 
 [testenv]
 commands =
+    python3 --version
     make review
 extras =
     test