Merge branch 'release-0.0.2'

Author: sinoroc

.gitlab-ci.yml

@@ -21,6 +21,7 @@
 
 'test py38 dev':
   <<: *job_test_common
+  allow_failure: true
   image: 'python:3.8-rc'
   variables:
     'TOXENV': 'py38'

CHANGELOG.rst

@@ -2,9 +2,19 @@
 
 
 .. Keep the current version number on line number 5
+0.0.2
+==========
+
+2019-06-11
+
+* Code refactored for easier usage as a library
+
+
 0.0.1
 =====
 
+2019-05-07
+
 Initial version
 
 

Makefile

@@ -14,17 +14,19 @@ develop:
 
 
 .PHONY: package
-package: sdist wheel check zapp
+package: sdist wheel zapp
 
 
 .PHONY: sdist
 sdist:
 	python3 setup.py sdist
+	python3 -m twine check dist/*.tar.gz
 
 
 .PHONY: wheel
 wheel:
 	python3 setup.py bdist_wheel
+	python3 -m twine check dist/*.whl
 
 
 .PHONY: zapp
@@ -33,9 +35,8 @@ zapp:
 
 
 .PHONY: check
-check: sdist wheel
-	python3 -m twine check dist/*.tar.gz
-	python3 -m twine check dist/*.whl
+check:
+	python3 setup.py check
 
 
 .PHONY: lint
@@ -63,7 +64,7 @@ pytest:
 
 
 .PHONY: review
-review:
+review: check
 	python3 -m pytest --pep8 --pylint
 
 

README.rst

@@ -15,15 +15,41 @@ Standalone application
 
 .. code::
 
-    zapp myapp.pyz myapp.core:main myapp
+    zapp ~/bin/myapp myapp.cli:main 'myapp==1.2.3' 'mylib==3.2.1'
+
+    python3 -m zapp ~/bin/myapp myapp.cli:main 'myapp==1.2.3' 'mylib==3.2.1'
+
+    zapp toolmaker.pyz toolmaker.cli:main toolmaker
+    zapp pipdeptree.pyz pipdeptree:main pipdeptree
+    zapp ~/bin/httpie httpie.__main__:main httpie
+
+    # Without requirements
+    zapp zipfile.pyz zipfile:main
+
+
+Library
+-------
+
+.. code::
+
+    import zapp
+
+    zapp.core.build_zapp(
+        [
+            'myapp==1.2.3',
+            'mylib==3.2.1',
+        ],
+        'myapp.cli:main',
+        'myapp.pyz',
+    )
 
 
 Setuptools command
 ------------------
 
 .. code::
 
-    python3 setup.py bdist_zapp --entry-point myapp.core:main
+    python3 setup.py bdist_zapp --entry-point myapp.cli:main
 
 
 Details

setup.cfg

@@ -1,22 +1,32 @@
 #
 
 
+[bdist_zapp]
+entry_point = zapp.cli:main
+
+
+[check]
+metadata = 1
+strict = 1
+
+
 [metadata]
 name = zapp
 author = sinoroc
 author_email = sinoroc.code+python@gmail.com
 description = zapp application
 license = Apache-2.0
 long_description = file: README.rst
+long_description_content_type = text/x-rst
 url = https://pypi.org/project/zapp
 
 
 [options]
 install_requires =
-    setuptools
+    importlib_metadata
     wheel
 package_dir =
-    =src
+    = src
 packages = find:
 
 
@@ -41,10 +51,6 @@ test =
 where = src
 
 
-[bdist_zapp]
-entry_point = zapp.cli:main
-
-
 [tool:pytest]
 addopts =
     --pylint-error-types='CEFIRW'

src/zapp/__init__.py

@@ -4,6 +4,7 @@
 """ Module initializer """
 
 
+from . import core
 from . import meta
 
 

src/zapp/cli.py

@@ -5,7 +5,6 @@
 
 
 import argparse
-import tempfile
 
 from . import core
 from . import meta
@@ -22,10 +21,7 @@ def main():
     parser.add_argument('entry_point')
     parser.add_argument('requirements', metavar='requirement', nargs='*')
     args = parser.parse_args()
-    with tempfile.TemporaryDirectory() as install_dir:
-        if args.requirements:
-            core.install_to_dir(install_dir, args.requirements)
-        core.build_zipapp(install_dir, args.entry_point, args.output_file)
+    core.build_zapp(args.requirements, args.entry_point, args.output_file)
 
 
 # EOF

src/zapp/core.py

@@ -32,7 +32,7 @@ def _venv_create(venv_dir):
     return venv_context
 
 
-def install_to_dir(target_dir, requirements):
+def _install_to_dir(target_dir, requirements):
     """ 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
@@ -48,9 +48,7 @@ def install_to_dir(target_dir, requirements):
         subprocess.run(command)
 
 
-def build_zipapp(source_dir, entry_point, output_file):
-    """ Build the 'zipapp' file
-    """
+def _create_zipapp_archive(source_dir, entry_point, output_file):
     zipapp.create_archive(
         source_dir,
         interpreter='/usr/bin/env python3',
@@ -59,6 +57,15 @@ def build_zipapp(source_dir, entry_point, output_file):
     )
 
 
+def build_zapp(requirements, entry_point, output_file):
+    """ Build a zapp binary archive
+    """
+    with tempfile.TemporaryDirectory() as install_dir:
+        if requirements:
+            _install_to_dir(install_dir, requirements)
+        _create_zipapp_archive(install_dir, entry_point, output_file)
+
+
 class bdist_zapp(setuptools.Command):  # pylint: disable=invalid-name
     """ Custom 'setuptools' command to build a zipapp
     """
@@ -93,12 +100,12 @@ class bdist_zapp(setuptools.Command):  # pylint: disable=invalid-name
         'keep-temp',
     ]
 
-    def __init__(self, *argv, **kwargs):
+    def __init__(self, *args, **kwargs):
         self.bdist_dir = None
         self.dist_dir = None
         self.entry_point = None
         self.keep_temp = 0
-        super().__init__(*argv, **kwargs)
+        super().__init__(*args, **kwargs)
 
     def initialize_options(self):
         """ Override """
@@ -153,9 +160,13 @@ def run(self):
                 raise distutils.errors.DistutilsInternalError(
                     "can not find bdist_wheel",
                 )
-            install_to_dir(self.bdist_dir, [dist_file])
+            _install_to_dir(self.bdist_dir, [dist_file])
             self.mkpath(self.dist_dir)
-            build_zipapp(self.bdist_dir, self.entry_point, output_file)
+            _create_zipapp_archive(
+                self.bdist_dir,
+                self.entry_point,
+                output_file,
+            )
             if not self.keep_temp:
                 distutils.dir_util.remove_tree(
                     self.bdist_dir,

src/zapp/meta.py

@@ -4,10 +4,10 @@
 """ Meta information """
 
 
-import pkg_resources
+import importlib_metadata
 
 
-VERSION = pkg_resources.get_distribution('zapp').version
+VERSION = importlib_metadata.version('zapp')
 
 
 # EOF