clean

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+omit =
+        *venv/*
+
+branch = True

.gitignore

@@ -0,0 +1,135 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+
+# jca
+.idea/
+app/
+_*/

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at j@abel.co. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 James Abel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,2 @@
+# pyship
+utility to enable shipping a python application to users

blackify.bat

@@ -0,0 +1,3 @@
+REM can run into this bug
+REM https://github.com/psf/black#ignoring-unmodified-files
+venv\Scripts\black.exe -l 192 pyship examples\example_cli\example_cli examples\example_gui\example_gui

build.bat

@@ -0,0 +1 @@
+venv\Scripts\python.exe -m flit build

coverage.bat

@@ -0,0 +1,2 @@
+set PYTHONPATH=%CD%
+venv\Scripts\pytest.exe --cov-report=html --cov

doc/high_level_description.txt

@@ -0,0 +1,34 @@
+
+- Create a virtual environment for your project like usual.
+  - Make pyship one of the requirements.
+- Create your a Python package (AKA a module) that can be invoked as an application with the python -m switch.
+- Package up your package.  For example, using flit or setup.py. This will end up in a distribution directory, often called dist.
+- Run pyship.  It will create the following directory structure:
+
+  <app_dir>                                                 # default of "app"
+    <platform>                                              # e.g. win64
+      <app_name>                                            # your app name
+        <app_name> launcher executable                      # e.g. myapp.exe so the OS sees an .exe for this app
+        <app_name>_<version>                                # the launcher calls into this directory (may be more than one)
+          Scripts                                           # e.g. python.exe
+          Lib                                               # your app and everything it needs gets installed here
+        (other artifacts, such as icons, metadata, etc.)    # other things the launcher or OS needs
+
+  For example, an app called myapp in Windows 64 would be:
+
+  app
+    win64
+      myapp
+        myapp.exe
+        myapp_0.0.1
+          Scripts
+            python.exe
+            pythonw.exe
+          Lib
+            site-packages
+
+  - steps
+    - create the launcher executable and support files and put it in <app_dir>/<platform>/<app_name>
+    - build the python execution environment in <app_dir>/<platform>/<app_name>/<app_name>_<version>
+    - using the application's execution requirements (from pyproject.toml), install requirements in <app_dir>/<platform>/<app_name>/<app_name>_<version>
+      (specifically the Lib/site-packages subdirectory)

doc/todo.txt

@@ -0,0 +1,2 @@
+
+- this is actually a sundry todo, but extract the required parts of sundry into a new package since sundry brings in too many things for this tool

examples/example_cli/example_cli/__init__.py

@@ -0,0 +1,2 @@
+from .__version__ import __application_name__, __version__, __author__, __author_email__, __url__, __download_url__, __description__, __is_gui__
+from .example_cli import example_cli

examples/example_cli/example_cli/__main__.py

@@ -0,0 +1,6 @@
+from ismain import is_main
+
+from .example_cli import example_cli
+
+if is_main():
+    example_cli()

examples/example_cli/example_cli/__version__.py

@@ -0,0 +1,10 @@
+__application_name__ = "example_cli"
+__version__ = "0.0.1"
+__author__ = "James Abel"
+__description__ = "example CLI app"
+__url__ = "https://github.com/jamesabel/pyship"
+__download_url__ = "https://github.com/jamesabel/pyship/archive/master.zip"
+__author_email__ = "j@abel.co"
+__license__ = "MIT"
+__copyright__ = "Copyright 2020 James Abel"
+__is_gui__ = False

examples/example_cli/example_cli/example_cli.py

@@ -0,0 +1,2 @@
+def example_cli():
+    print("Congratulations - you have successfully run the pyship example!")

examples/example_cli/pyship.bat

@@ -0,0 +1,5 @@
+REM pyship the app
+call venv\Scripts\activate.bat
+REM remove the --pyship_dist_dir when pyship is on PyPI
+python -m pyship --pyship_dist_dir "..\..\dist"
+deactivate

examples/example_cli/requirements-dev.txt

@@ -0,0 +1,6 @@
+#
+# pyship
+#
+typeguard
+pyinstaller
+pytest

examples/example_cli/setup.py

@@ -0,0 +1,28 @@
+import os
+
+from setuptools import setup
+
+from example_cli import __application_name__, __version__, __author__, __author_email__, __url__, __download_url__, __description__
+
+readme_file_path = os.path.join(__application_name__, "readme.md")
+
+with open(readme_file_path, encoding="utf-8") as f:
+    long_description = "\n" + f.read()
+
+setup(
+    name=__application_name__,
+    description=__description__,
+    long_description=long_description,
+    long_description_content_type="text/x-rst",
+    version=__version__,
+    author=__author__,
+    author_email=__author_email__,
+    license="MIT License",
+    url=__url__,
+    download_url=__download_url__,
+    keywords=["example", "console", "cli"],
+    packages=[__application_name__],
+    package_data={__application_name__: [readme_file_path]},
+    install_requires=["ismain"],  # for now pyship has to be installed separately, until it's on PyPI
+    classifiers=[],
+)

examples/example_gui/example_gui/__init__.py

@@ -0,0 +1,2 @@
+from .__version__ import __version__, __application_name__, __author__, __author_email__, __url__, __download_url__, __description__, __is_gui__
+from .example_gui import example_gui

examples/example_gui/example_gui/__main__.py

@@ -0,0 +1,6 @@
+from ismain import is_main
+
+from .example_gui import example_gui
+
+if is_main():
+    example_gui()

examples/example_gui/example_gui/__version__.py

@@ -0,0 +1,10 @@
+__application_name__ = "example_gui"
+__version__ = "0.0.1"
+__author__ = "James Abel"
+__description__ = "example GUI app"
+__url__ = "https://github.com/jamesabel/pyship"
+__download_url__ = "https://github.com/jamesabel/pyship/archive/master.zip"
+__author_email__ = "j@abel.co"
+__license__ = "MIT"
+__copyright__ = "Copyright 2020 James Abel"
+__is_gui__ = True

examples/example_gui/example_gui/example_gui.py

@@ -0,0 +1,21 @@
+import sys
+
+from PyQt5.QtWidgets import QMessageBox, QApplication
+from ismain import is_main
+
+__title__ = "example_gui"
+
+
+def example_gui():
+    app = QApplication(sys.argv)
+    mb = QMessageBox()
+    mb.setIcon(QMessageBox.Information)
+    mb.setWindowTitle(__title__)
+    mb.setText(f"Congratulations - you have successfully run the {__title__} example!")
+    mb.setStandardButtons(QMessageBox.Ok)
+    mb.show()
+    app.exec_()
+
+
+if is_main():
+    example_gui()

examples/example_gui/pyship.bat

@@ -0,0 +1,5 @@
+REM pyship app
+call venv\Scripts\activate.bat
+REM remove the --pyship_dist_dir when pyship is on PyPI
+python -m pyship --pyship_dist_dir "..\..\dist"
+deactivate

examples/example_gui/requirements-dev.txt

@@ -0,0 +1,8 @@
+#
+# pyship
+#
+PyQt5
+#
+typeguard
+pyinstaller
+pytest