Merge ~woutervb/snapstore-client:move_to_setuptools into snapstore-client:master

[Wouter van Bommel]

Move the project to setuptool

By being a proper setuptools based application, the snap building becomes simpler and it is needed to move to click for commandline parsing

Related to https://code.launchpad.net/~woutervb/snapstore-client/+git/snapstore-client/+merge/414489 and thus https://code.launchpad.net/~woutervb/snapstore-client/+git/snapstore-client/+merge/414340/comments/1095890

[Maximiliano Bertacchini (maxiberta)]

LGTM! +1

review: Approve

[Maximiliano Bertacchini (maxiberta)]

Please check comment on the package name.

[Otto Co-Pilot (otto-copilot)]

Running landing tests failed
https://jenkins.ols.canonical.com/online-services/job/snapstore-client/25/

[Otto Co-Pilot (otto-copilot)]

Running landing tests failed
https://jenkins.ols.canonical.com/online-services/job/snapstore-client/26/

diff --git a/Makefile b/Makefile
index 19eeaa7..76ddd0a 100644
--- a/Makefile
+++ b/Makefile
@@ -25,7 +25,7 @@ $(ENV)/dev: $(ENV)/prod
 bootstrap: $(ENV)/prod
 
 snap:
-	snapcraft build
+	snapcraft
 
 test: $(ENV)/dev
 	$(PYTHON3) -m unittest $(TESTS) 2>&1
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..7ff4d8a
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,17 @@
+from setuptools import find_namespace_packages, setup
+
+
+with open("requirements.txt") as f:
+    install_requires = f.read().splitlines()
+
+setup(
+    name="snap-store-proxy-client-admin",
+    version="1.1.0",
+    packages=find_namespace_packages(),
+    install_requires=install_requires,
+    entry_points={
+        "console_scripts": [
+            "snapstore = snapstore_client.main:main",
+        ],
+    },
+)
diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml
index 8811c64..6139474 100644
--- a/snap/snapcraft.yaml
+++ b/snap/snapcraft.yaml
@@ -1,36 +1,27 @@
 name: snap-store-proxy-client
 base: core20
-version: "1.1"
 summary: Canonical snap store proxy administration client.
 description: |
   The Canonical snapstore client is used to manage a snap store proxy.
 
-# Defaults, but snapcraft prints ugly yellow messages without them.
 confinement: strict
 grade: stable
+adopt-info: snap-store-proxy-client
 
 architectures:
   - build-on: amd64
 
 apps:
   snap-store-proxy-client:
-    command: ./snapstore
+    command: bin/snapstore
     plugs:
       - network
 
 parts:
-  deps:
+  snap-store-proxy-client:
     plugin: python
     source: .
-    requirements:
-      - ${SNAPCRAFT_PART_SRC}/requirements.txt
-  source:
-    plugin: dump
-    source: .
-    stage:
-      - snapstore
-      - snapstore_client/
-    override-prime: |
-      snapcraftctl prime
-      python3 -m compileall -q -j0 snapstore_client
-
+    override-build: |
+        snapcraftctl build
+        version="$(python3 setup.py --version)"
+        snapcraftctl set-version "$version"
diff --git a/snapstore b/snapstore_client/main.py
similarity index 53%
rename from snapstore
rename to snapstore_client/main.py
index cd67b71..d3d9c8c 100755
--- a/snapstore
+++ b/snapstore_client/main.py
@@ -20,7 +20,7 @@ from snapstore_client.logic.overrides import (
 from snapstore_client.logic.push import push_snap
 
 
-DEFAULT_SSO_URL = 'https://login.ubuntu.com/'
+DEFAULT_SSO_URL = "https://login.ubuntu.com/"
 
 
 def main():
@@ -37,87 +37,101 @@ def main():
 
 def parse_args():
     parser = argparse.ArgumentParser()
-    subparsers = parser.add_subparsers(help='sub-command help')
+    subparsers = parser.add_subparsers(help="sub-command help")
 
     login_parser = subparsers.add_parser(
-        'login', help='Sign into a store.',
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
-    login_parser.add_argument('store_url', help='Store URL')
-    login_parser.add_argument('email', help='Ubuntu One SSO email', nargs='?')
-    login_parser.add_argument('--sso-url', help='Ubuntu One SSO URL',
-                              default=DEFAULT_SSO_URL)
-    login_parser.add_argument('--offline', help="Use offline mode interaction",
-                              action='store_true')
+        "login",
+        help="Sign into a store.",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+    )
+    login_parser.add_argument("store_url", help="Store URL")
+    login_parser.add_argument("email", help="Ubuntu One SSO email", nargs="?")
+    login_parser.add_argument(
+        "--sso-url", help="Ubuntu One SSO URL", default=DEFAULT_SSO_URL
+    )
+    login_parser.add_argument(
+        "--offline", help="Use offline mode interaction", action="store_true"
+    )
     login_parser.set_defaults(func=login)
 
     list_overrides_parser = subparsers.add_parser(
-        'list-overrides', help='List channel map overrides.',
+        "list-overrides",
+        help="List channel map overrides.",
     )
     list_overrides_parser.add_argument(
-        '--series', default='16',
-        help='The series within which to list overrides.')
+        "--series", default="16", help="The series within which to list overrides."
+    )
     list_overrides_parser.add_argument(
-        'snap_name',
-        help='The name of the snap whose channel map should be listed.')
+        "snap_name", help="The name of the snap whose channel map should be listed."
+    )
     list_overrides_parser.add_argument(
-        '--password',
-        help='Password for interacting with an offline proxy',
-        default=os.environ.get('SNAP_PROXY_PASSWORD')
+        "--password",
+        help="Password for interacting with an offline proxy",
+        default=os.environ.get("SNAP_PROXY_PASSWORD"),
     )
     list_overrides_parser.set_defaults(func=list_overrides)
 
     override_parser = subparsers.add_parser(
-        'override', help='Set channel map overrides.',
+        "override",
+        help="Set channel map overrides.",
     )
     override_parser.add_argument(
-        '--series', default='16',
-        help='The series within which to set overrides.')
+        "--series", default="16", help="The series within which to set overrides."
+    )
     override_parser.add_argument(
-        'snap_name',
-        help='The name of the snap whose channel map should be modified.')
+        "snap_name", help="The name of the snap whose channel map should be modified."
+    )
     override_parser.add_argument(
-        'channel_map_entries', nargs='+', metavar='channel_map_entry',
-        help='A channel map override, in the form <channel>=<revision>.')
+        "channel_map_entries",
+        nargs="+",
+        metavar="channel_map_entry",
+        help="A channel map override, in the form <channel>=<revision>.",
+    )
     override_parser.add_argument(
-        '--password',
-        help='Password for interacting with an offline proxy',
-        default=os.environ.get('SNAP_PROXY_PASSWORD')
+        "--password",
+        help="Password for interacting with an offline proxy",
+        default=os.environ.get("SNAP_PROXY_PASSWORD"),
     )
     override_parser.set_defaults(func=override)
 
     delete_override_parser = subparsers.add_parser(
-        'delete-override', help='Delete channel map overrides.',
+        "delete-override",
+        help="Delete channel map overrides.",
     )
     delete_override_parser.add_argument(
-        '--series', default='16',
-        help='The series within which to delete overrides.')
+        "--series", default="16", help="The series within which to delete overrides."
+    )
     delete_override_parser.add_argument(
-        'snap_name',
-        help='The name of the snap whose channel map should be modified.')
+        "snap_name", help="The name of the snap whose channel map should be modified."
+    )
     delete_override_parser.add_argument(
-        'channels', nargs='+', metavar='channel',
-        help='A channel whose overrides should be deleted.')
+        "channels",
+        nargs="+",
+        metavar="channel",
+        help="A channel whose overrides should be deleted.",
+    )
     delete_override_parser.add_argument(
-        '--password',
-        help='Password for interacting with an offline proxy',
-        default=os.environ.get('SNAP_PROXY_PASSWORD')
+        "--password",
+        help="Password for interacting with an offline proxy",
+        default=os.environ.get("SNAP_PROXY_PASSWORD"),
     )
     delete_override_parser.set_defaults(func=delete_override)
 
     push_snap_parser = subparsers.add_parser(
-        'push-snap', help='push a snap to an offline proxy')
+        "push-snap", help="push a snap to an offline proxy"
+    )
     push_snap_parser.add_argument(
-        'snap_tar_file',
-        help='The .tar.gz file of a bundled downloaded snap')
+        "snap_tar_file", help="The .tar.gz file of a bundled downloaded snap"
+    )
     push_snap_parser.add_argument(
-        '--push-channel-map',
-        action='store_true',
-        help="Force push of the channel map,"
-             " removing any existing overrides")
+        "--push-channel-map",
+        action="store_true",
+        help="Force push of the channel map," " removing any existing overrides",
+    )
     push_snap_parser.add_argument(
-        '--password',
-        help='Password for interacting with an offline proxy',
-        default=os.environ.get('SNAP_PROXY_PASSWORD')
+        "--password",
+        help="Password for interacting with an offline proxy",
+        default=os.environ.get("SNAP_PROXY_PASSWORD"),
     )
     push_snap_parser.set_defaults(func=push_snap)
 
@@ -129,5 +143,5 @@ def parse_args():
     return parser.parse_args()
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     sys.exit(main())