Modify template to be v0.3 compliant.

.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install --upgrade setuptools
+        python -m pip install tox
+    - name: Test with tox
+      run: |
+        tox

.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.python-version
+.vscode

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Contributing
+
+BeeWare <3's contributions!
+
+Please be aware, BeeWare operates under a Code of Conduct.
+
+See [CONTRIBUTING to BeeWare](https://beeware.org/contributing) for details.
+

README.rst

@@ -13,7 +13,7 @@ Using this template
 
 2. Run ``cookiecutter`` on this template::
 
-    $ cookiecutter https://github.com/pybee/briefcase-template
+    $ cookiecutter https://github.com/beeware/briefcase-template
 
 3. Add your code to the project.
 
@@ -22,14 +22,15 @@ Using this template
 
     $ pip install briefcase
 
-5. Use Briefcase to generate the artifacts for your platform of choice::
+5. Use Briefcase to generate a project::
 
-    $ python setup.py ios
-    $ python setup.py android
-    $ python setup.py macos
-    $ python setup.py windows
-    $ python setup.py linux
-    $ python setup.py django
+    $ briefcase create
+    $ briefcase run
 
-.. _cookiecutter: http://github.com/audreyr/cookiecutter
-.. _briefcase: http://github.com/pybee/briefcase
+   To build for a mobile platform, add the platform name::
+
+    $ briefcase create iOS
+    $ briefcase run iOS
+
+.. _cookiecutter: http://github.com/cookiecutter/cookiecutter
+.. _briefcase: http://github.com/beeware/briefcase

cookiecutter.json

@@ -1,10 +1,14 @@
 {
     "formal_name": "Hello World",
     "app_name": "{{ cookiecutter.formal_name|lower|replace(' ', '') }}",
+    "class_name": "{{ cookiecutter.formal_name.title().replace(' ','').replace('-','').replace('!','').replace('.','').replace(',','') }}",
+    "module_name": "{{ cookiecutter.app_name|lower|replace('-', '_') }}",
+    "project_name": "Project Awesome",
     "description": "An app that does lots of stuff",
     "author": "Jane Developer",
     "author_email": "[email protected]",
     "bundle": "com.example",
+    "url": "https://example.com",
     "license": [
         "BSD license",
         "MIT license",
@@ -13,11 +17,13 @@
         "GNU General Public License v2 or later (GPLv2+)",
         "GNU General Public License v3 (GPLv3)",
         "GNU General Public License v3 or later (GPLv3+)",
+        "Proprietary",
         "Other"
     ],
     "gui_framework": [
         "Toga",
         "PySide2",
+        "PursuedPyBear",
         "None"
     ]
 }

hooks/pre_gen_project.py

@@ -2,12 +2,16 @@
 import sys
 
 
-MODULE_REGEX = r'^[_a-zA-Z][_a-zA-Z0-9]+$'
+# The restriction on application naming comes from PEP508
+PEP508_NAME_RE = re.compile(
+    r'^([A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9])$',
+    re.IGNORECASE
+)
 
 app_name = '{{ cookiecutter.app_name }}'
 
-if not re.match(MODULE_REGEX, app_name):
-    print('ERROR: `%s` is not a valid Python module name!' % app_name)
+if not re.match(PEP508_NAME_RE, app_name):
+    print('ERROR: `%s` is not a valid Python package name!' % app_name)
 
     # exits with status 1 to indicate failure
     sys.exit(1)

tests/test_app_template.py

@@ -0,0 +1,66 @@
+import pathlib
+import shutil
+
+from cookiecutter import main
+from flake8.api import legacy as flake8
+import py_compile
+import pytest
+import toml
+
+TEST_CASES = [
+    {},  # use only the default briefcase-template values
+    {"gui_framework": "1"},  # Toga GUI framework
+    {"gui_framework": "2"},  # PySide2 GUI framework
+    {"gui_framework": "3"},  # PursuedPyBear GUI framework
+    {"gui_framework": "4"},  # "None" for GUI framework
+]
+
+
+@pytest.fixture
+def app_directory(tmpdir_factory, args):
+    """Fixture for a default app."""
+    print(args)
+    output_dir = tmpdir_factory.mktemp("default-app")
+    output_dir = pathlib.Path(str(output_dir)).resolve()
+    root_dir = pathlib.Path(__file__).parent.parent.resolve()
+    main.cookiecutter(
+        str(root_dir), no_input=True, output_dir=str(output_dir),
+    )
+    return output_dir
+
+
+def _all_filenames(directory):
+    """Return list of filenames in a directory, excluding __pycache__ files."""
+    filenames = []
+    for root, _, files in pathlib.os.walk(str(directory)):
+        for f in files:
+            full_filename = root+pathlib.os.sep+f
+            if "__pycache__" not in full_filename:
+                filenames.append(full_filename)
+    filenames.sort()
+    return filenames
+
+
+@pytest.mark.parametrize('args', TEST_CASES)
+def test_parse_pyproject_toml(app_directory):
+    """Test for errors in parsing the generated pyproject.toml file."""
+    pyproject_toml = app_directory/"helloworld"/"pyproject.toml"
+    assert pyproject_toml.is_file()  # check pyproject.toml exists
+    toml.load(pyproject_toml)  # any error in parsing will trigger pytest
+
+
+@pytest.mark.parametrize('args', TEST_CASES)
+def test_flake8_app(app_directory, args):
+    """Check there are no flake8 errors in any of the generated python files"""
+    files = [f for f in _all_filenames(app_directory) if f.endswith(".py")]
+    style_guide = flake8.get_style_guide()
+    report = style_guide.check_files(files)
+    assert report.get_statistics("E") == [], "Flake8 found violations"
+
+
+@pytest.mark.parametrize('args', TEST_CASES)
+def test_files_compile(app_directory, args):
+    files = [f for f in _all_filenames(app_directory) if f.endswith(".py")]
+    for filename in files:
+        # If there is a compilation error, pytest is triggered
+        py_compile.compile(filename)

tox.ini

@@ -0,0 +1,12 @@
+[tox]
+envlist = py, py35
+
+[testenv]
+skip_install = True
+deps =
+  cookiecutter
+  flake8
+  pytest
+  pytest-tldr
+  toml
+commands = pytest

{{ cookiecutter.app_name }}/LICENSE

@@ -112,4 +112,8 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
+{% elif cookiecutter.license == 'Proprietary' %}
+Copyright (C) {% now 'local', '%Y' %}  {{ cookiecutter.author }}
+
+All rights reserved.
 {% endif %}

{{ cookiecutter.app_name }}/README.rst

@@ -7,6 +7,6 @@ consider** `becoming a financial member of BeeWare`_.
 
 {{ cookiecutter.description }}
 
-.. _`Briefcase`: https://github.com/pybee/briefcase
-.. _`The BeeWare Project`: https://pybee.org/
-.. _`becoming a financial member of BeeWare`: https://pybee.org/contributing/membership
+.. _`Briefcase`: https://github.com/beeware/briefcase
+.. _`The BeeWare Project`: https://beeware.org/
+.. _`becoming a financial member of BeeWare`: https://beeware.org/contributing/membership

{{ cookiecutter.app_name }}/pyproject.toml

@@ -0,0 +1,67 @@
+[tool.briefcase]
+project_name = "{{ cookiecutter.project_name }}"
+bundle = "{{ cookiecutter.bundle }}"
+version = "0.0.1"
+url = "{{ cookiecutter.url }}"
+license = "{{ cookiecutter.license }}"
+author = '{{ cookiecutter.author }}'
+author_email = "{{ cookiecutter.author_email }}"
+
+[tool.briefcase.app.{{ cookiecutter.app_name }}]
+formal_name = "{{ cookiecutter.formal_name }}"
+description = "{{ cookiecutter.description }}"
+icon = "src/{{ cookiecutter.module_name }}/resources/{{ cookiecutter.app_name }}"
+sources = ['src/{{ cookiecutter.module_name }}']
+requires = [
+{%- if cookiecutter.gui_framework == 'PySide2' %}
+    'pyside2==5.13.0',
+{%- elif cookiecutter.gui_framework == 'PursuedPyBear' %}
+    'ppb~=0.8.0',
+{% endif -%}
+]
+
+
+[tool.briefcase.app.{{ cookiecutter.app_name }}.macOS]
+requires = [
+{%- if cookiecutter.gui_framework == 'Toga' %}
+    'toga-cocoa>=0.3.0.dev18',
+{% endif -%}
+]
+
+[tool.briefcase.app.{{ cookiecutter.app_name }}.linux]
+requires = [
+{%- if cookiecutter.gui_framework == 'Toga' %}
+    'toga-gtk>=0.3.0.dev18',
+{% endif -%}
+]
+system_requires = [
+{%- if cookiecutter.gui_framework == 'Toga' %}
+    'libgirepository1.0-dev',
+    'libcairo2-dev',
+    'libpango1.0-dev',
+    'libwebkitgtk-3.0-0',
+    'gir1.2-webkit-3.0',
+{% endif -%}
+]
+
+[tool.briefcase.app.{{ cookiecutter.app_name }}.windows]
+requires = [
+{%- if cookiecutter.gui_framework == 'Toga' %}
+    'toga-winforms>=0.3.0.dev18',
+{% endif -%}
+]
+
+# Mobile deployments
+[tool.briefcase.app.{{ cookiecutter.app_name }}.iOS]
+requires = [
+{%- if cookiecutter.gui_framework == 'Toga' %}
+    'toga-iOS>=0.3.0.dev18',
+{% endif -%}
+]
+
+[tool.briefcase.app.{{ cookiecutter.app_name }}.android]
+requires = [
+{%- if cookiecutter.gui_framework == 'Toga' %}
+    'toga-android>=0.3.0.dev18',
+{% endif -%}
+]

{{ cookiecutter.app_name }}/{{ cookiecutter.app_name }}/__main__.py → {{ cookiecutter.app_name }}/src/{{ cookiecutter.module_name }}/__main__.py

@@ -1,4 +1,4 @@
-from {{ cookiecutter.app_name }}.app import main
+from {{ cookiecutter.module_name }}.app import main
 
 if __name__ == '__main__':
 {%- if cookiecutter.gui_framework == 'Toga' %}