Merge lp:~smoser/simplestreams/trunk.deprecated-bzr into lp:simplestreams

[Scott Moser]

Warn on usage of checked out bzr.

This supplies a UserWarning until 2018-07-31 to inform the user
that they've used bzr from the wrong place.
After that it raises DeprecationWarning.

If neeed, adding SIMPLESTREAMS_BZR=1 to the environment will
turn this error into a warning.

[Philip Roche (philroche)]

+1

review: Approve

[Scott Moser (smoser)]

https://code.launchpad.net/~smoser/simplestreams/trunk.moved-to-git/+merge/348547
follows on this.

=== modified file 'Makefile'
--- Makefile	2016-08-03 17:10:01 +0000
+++ Makefile	2018-06-25 18:03:37 +0000
@@ -11,9 +11,9 @@
 test: test2 test3 flake8
 
 test3: examples-sign
-	$(TENV) nosetests3 -v tests/
+	SIMPLESTREAMS_BZR=1 $(TENV) nosetests3 -v tests/
 test2: examples-sign
-	$(TENV) nosetests -v tests/
+	SIMPLESTREAMS_BZR=1 $(TENV) nosetests -v tests/
 
 flake8:
 	# any means run via 'flake8' or 'python3 -m flake8'
 
=== modified file 'README.txt'
--- README.txt	2013-05-07 17:25:58 +0000
+++ README.txt	2018-06-25 18:03:37 +0000
@@ -1,52 +1,11 @@
-== Intro ==
-This is a documentation, examples, a python library and some tools for
-interacting with simple streams format.
-
-The intent of simple streams format is to make well formated data available
-about "products".
-
-There is more documentation in doc/README.
-There are examples in examples/.
-
-== Simple Streams Getting Started ==
-
-= Mirroring ==
-To mirror one source (http or file) to a local directory, see tools/do-mirror.
-For example, to mirror the 'foocloud' example content, do:
-   ./tools/tenv do-mirror examples/foocloud/ my.out streams/v1/index.json
-
-That will create a full mirror in my.out/.
-
-   ./tools/tenv do-mirror --mirror=http://download.cirros-cloud.net/ \
-       --max=1 examples/cirros/ cirros.mirror/
-
-That will create a mirror of cirros data in cirros.mirror, with only
-the latest file from each product.
-
-= Hooks =
-To use the "command hooks mirror" for invoking commands to synchronize, between
-one source and another, see bin/sstream-sync.
-
-For an example, the following runs the debug hook against the example 'foocloud'
-data:
-   ./tools/tenv sstream-sync --hook=hook-debug \
-       --path=streams/v1/index.json examples/foocloud/
-
-You can also run it with cloud-images.ubuntu.com data like this:
-
-  ./tools/tenv sstream-sync \
-     --item-skip-download --hook=./tools/hook-debug \
-     --path=streams/v1/index.sjson http://cloud-images.ubuntu.com/releases/
-
-The 'hook-debug' program simply outputs the data it is invoked with.  It does
-not actually mirror anything.
-
-
-== Glance ==
-Example mirror of a download image source to glance with swift serving
-a localized image-id format:
-
-./tools/sstream-mirror-glance --region=RegionOne \
-   --cloud-name=localcloud "--content-id=localcloud.%(region)s:partners" \
-   --output-swift=published/ --max=1 --name-prefix="ubuntu/" \
-   http://cloud-images.ubuntu.com/releases/ streams/v1/index.json
+****************************************************************************
+** Simplestreams has moved its development from bzr to git.               **
+**                                                                        **
+** If you are seeing this message, it means you have checked out via bzr. **
+** Please update your workflow to use git.  Instead of                    **
+**   bzr branch lp:simplestreams                                          **
+** use:                                                                   **
+**   git clone https://git.launchpad.net/simplestreams                    **
+**                                                                        **
+** This bzr repository is expected to be removed by 2018-07-31            **
+****************************************************************************
 
=== modified file 'simplestreams/__init__.py'
--- simplestreams/__init__.py	2013-03-15 21:10:58 +0000
+++ simplestreams/__init__.py	2018-06-25 18:03:37 +0000
@@ -1,1 +1,16 @@
+import os
+
+_readme = os.path.join(os.path.dirname(__file__), "..", "README.txt")
+if os.path.exists(_readme):
+    from datetime import date
+    import warnings
+    with open(_readme, "r") as fp:
+        content = fp.read()
+    if (not os.environ.get("SIMPLESTREAMS_BZR") and
+            date.today() > date(2018, 7, 31)):
+        raise DeprecationWarning("\n" + content)
+    else:
+        warnings.showwarning("\n" + content, UserWarning,
+                             filename=None, lineno=None, line=False)
+
 # vi: ts=4 expandtab
 
=== modified file 'tox.ini'
--- tox.ini	2017-10-24 13:38:58 +0000
+++ tox.ini	2018-06-25 18:03:37 +0000
@@ -4,6 +4,7 @@
 [testenv]
 setenv =
    GNUPGHOME={toxinidir}/gnupg
+   SIMPLESTREAMS_BZR=1
 commands = 
     {toxinidir}/tools/create-gpgdir
     {toxinidir}/tools/sign-examples