Merge lp:~oubiwann/txamqp/385371-top-level-reorg into lp:txamqp

[Duncan McGreggor]

[Duncan McGreggor (oubiwann)]

Could I get a review for these changes? Thomas and Chris, I believe this branch reflects a change that you guys were thinking about at UDS?

[lp:~oubiwann/txamqp/385371-top-level-reorg]

28. By Duncan McGreggor on 2009-06-09

- Fixed long lines.
- Updated example code to use PEP-8 formatting guidelines.
- Broke out callback as a top-level function (for clarity).
- Removed trailing whitespace.

29. By Duncan McGreggor on 2009-06-09

- Renamed files to remove contextually redundant "txamqp_".
- Updated README.

[Thomas Herve (therve)]

> Could I get a review for these changes? Thomas and Chris, I believe this
> branch reflects a change that you guys were thinking about at UDS?

I'd like to discuss it with Esteve first.

[Esteve Fernandez (esteve)]

> Could I get a review for these changes? Thomas and Chris, I believe this
> branch reflects a change that you guys were thinking about at UDS?

I agree with moving the specs directory to the top level directory, but not so much with removing src. IMHO, having an extra top level directory is not that cumbersome as you say, also it makes it easier to separate source code from other stuff (like Debian files, specs, etc.)

As for the README file, while I really appreciate it, it's worth pointing to the original article and giving credit to its authors (Matt Heitzenroder and Dan Reverri) instead of ripping off their work. Matt and Dan have done a much better work promoting and explaining txAMQP and txThrift in their blog than I have.

BTW, if you guys were thinking about this at UDS, why not mentioning it to upstream? I was in town after all :-)

PS: the blog post where you took the examples you added, actually links to http://blogs.digitar.com/jjww/2009/01/rabbits-and-warrens/#comment-681, which in turn link to my space at fluidinfo.com. Linking to http://fluidinfo.com/stuff/esteve would have been shorter :-)

[Duncan McGreggor (oubiwann)]

Esteve Fernandez wrote:
>> Could I get a review for these changes? Thomas and Chris, I believe
>> this branch reflects a change that you guys were thinking about at
>> UDS?
>
> I agree with moving the specs directory to the top level directory,
> but not so much with removing src. IMHO, having an extra top level
> directory is not that cumbersome as you say, also it makes it easier
> to separate source code from other stuff (like Debian files, specs,
> etc.)

Okay, cool. Sounds like a difference of personal preference :-)

> As for the README file, while I really appreciate it, it's worth
> pointing to the original article and giving credit to its authors
> (Matt Heitzenroder and Dan Reverri) instead of ripping off their
> work.

Wow, you see that as ripping off? I see it as their contribution to the
source examples...

> BTW, if you guys were thinking about this at UDS, why not mentioning
> it to upstream? I was in town after all :-)

I think "thinking about this" is probably too strong a phrase. It was
half-mentioned in passing as being a little cumbersome, that's all.

[Thomas Herve (therve)]

> > Could I get a review for these changes? Thomas and Chris, I believe this
> > branch reflects a change that you guys were thinking about at UDS?
>
> I agree with moving the specs directory to the top level directory, but not so
> much with removing src. IMHO, having an extra top level directory is not that
> cumbersome as you say, also it makes it easier to separate source code from
> other stuff (like Debian files, specs, etc.)

The problem with the src/ directory is that it makes it harder to use import it in general, and to use trial in particular.

> BTW, if you guys were thinking about this at UDS, why not mentioning it to
> upstream? I was in town after all :-)

Sorry I hoped we talked about more important stuff :). I think we just mentioned that quickly in a discussion.

But as Duncan said, this is also a matter of personal preference, so I understand if you don't want to change it, even just for not breaking current users expectations.

Thanks!

[Esteve Fernandez (esteve)]

> Wow, you see that as ripping off? I see it as their contribution to the
> source examples...

Sorry if it sounded too harsh ("ripping off"), but their names weren't in the README file nor was a link to their blog article. The README file is an exact copy of that article (http://app.arat.us/blog/?p=38) They did all the work of documenting how to get Bazaar, RabbitMQ, etc. running and I think they deserve to be credited somewhere.

In any case, I don't think running rabbitmq-server directly is a good idea, given that the Debian package already comes with an init.d script.

[Duncan McGreggor (oubiwann)]

Esteve Fernandez wrote:
>> Wow, you see that as ripping off? I see it as their contribution to the
>> source examples...
>>
>
> Sorry if it sounded too harsh ("ripping off"), but their names weren't in the README file nor was a link to their blog article. The README file is an exact copy of that article (http://app.arat.us/blog/?p=38) They did all the work of documenting how to get Bazaar, RabbitMQ, etc. running and I think they deserve to be credited somewhere.
>
Indeed. I guess you didn't see the bzr log? I gave them credit there.
Good point, though: they should definitely be credited someplace more
visible than that.

[Matt Heitzenroder (roder)]

Thanks everyone. I just wanted to chime in to say we're honored that
you've chosen to include our (all credit belongs to Dan) humble blog
posts . We are so grateful for txamqp, please keep up the good work.
We hope we can find a real way of giving back more :)

Cheers,
Matt

On Jun 10, at 8:54 AM, Duncan McGreggor wrote:

> Esteve Fernandez wrote:
>>> Wow, you see that as ripping off? I see it as their contribution
>>> to the
>>> source examples...
>>>
>>
>> Sorry if it sounded too harsh ("ripping off"), but their names
>> weren't in the README file nor was a link to their blog article.
>> The README file is an exact copy of that article (http://app.arat.us/blog/?p=38
>> ) They did all the work of documenting how to get Bazaar, RabbitMQ,
>> etc. running and I think they deserve to be credited somewhere.
>>
> Indeed. I guess you didn't see the bzr log? I gave them credit there.
> Good point, though: they should definitely be credited someplace more
> visible than that.
>
> --
> https://code.launchpad.net/~oubiwann/txamqp/385371-top-level-reorg/
> +merge/7258
> You are subscribed to branch lp:txamqp.

[Esteve Fernandez (esteve)]

review: Disapprove

Unmerged revisions

29. By Duncan McGreggor on 2009-06-09

- Renamed files to remove contextually redundant "txamqp_".
- Updated README.

28. By Duncan McGreggor on 2009-06-09

- Fixed long lines.
- Updated example code to use PEP-8 formatting guidelines.
- Broke out callback as a top-level function (for clarity).
- Removed trailing whitespace.

27. By Duncan McGreggor on 2009-06-09

Updated setup.py file.

26. By Duncan McGreggor on 2009-06-09

Renamed the example directory.

25. By Duncan McGreggor on 2009-06-09

More READM tweaks.

24. By Duncan McGreggor on 2009-06-09

More cleanup on the pub-sub example README.

23. By Duncan McGreggor on 2009-06-09

Added pub-sub example from http://app.arat.us/blog/?p=38.

22. By Duncan McGreggor on 2009-06-09

Moved thrift example into its own directory.

21. By Duncan McGreggor on 2009-06-09

Removed empty directory.

20. By Duncan McGreggor on 2009-06-09

Moved contents of src up one level.

=== renamed directory 'src/examples' => 'examples'
=== added directory 'examples/pub-con'
=== added file 'examples/pub-con/README'
--- examples/pub-con/README	1970-01-01 00:00:00 +0000
+++ examples/pub-con/README	2009-06-09 22:17:00 +0000
@@ -0,0 +1,71 @@
+This is a quick post on getting started using the txAMQP library with RabbitMQ
+on Ubuntu Jaunty.
+
+Install RabbitMQ
+
+    sudo apt-get install rabbitmq-server
+
+Note: Looks like the installer starts the rabbitmq-server automatically. I
+discovered this when I tried to start it from the terminal by running:
+
+    sudo rabbitmq-server
+
+which was followed by a series of angry error messages. To confirm a node was
+already running I ran:
+
+    sudo rabbitmqctl status
+
+In case a node is not already started you can run it attached or detached from
+the terminal:
+
+    sudo rabbitmq-server
+    sudo rabbitmq-server -detached
+
+The server can be stopped with:
+
+    sudo rabbitmqctl stop
+
+Install Twisted
+
+    sudo apt-get install python-twisted
+
+Install txAMQP
+
+The instructions below install txAQMP from trunk. There are Ubuntu packages
+available if you prefer, refer to the following for more details:
+
+    https://launchpad.net/~txamqpteam/+archive/ppa
+
+a. Install Bazaar
+
+    sudo apt-get install bzr
+
+b. Fetch txAQMP
+
+    cd ~
+    bzr branch lp:txamqp txamqp
+
+c. Install txAMQP
+
+    cd txamqp
+    sudo python setup.py install
+
+Simple example
+
+To see this example work you will need to open two terminal windows. In the
+first window type the following:
+
+    cd examples/pub-con
+    python \
+        txamqp_consumer.py \
+        ../../specs/standard/amqp0-8.xml
+
+In the second window type:
+
+    cd examples/pub-con
+    python \
+        txamqp_publisher.py \
+        ../../specs/standard/amqp0-8.xml \
+        "message to send to consumer"
+
+You should see the message appear in the terminal window running the consumer.

=== added file 'examples/pub-con/txamqp_consumer.py'
--- examples/pub-con/txamqp_consumer.py	1970-01-01 00:00:00 +0000
+++ examples/pub-con/txamqp_consumer.py	2009-06-09 22:04:43 +0000
@@ -0,0 +1,56 @@
+from twisted.internet.defer import inlineCallbacks
+from twisted.internet import reactor
+from twisted.internet.protocol import ClientCreator
+from txamqp.protocol import AMQClient
+from txamqp.client import TwistedDelegate
+import txamqp.spec
+
+@inlineCallbacks
+def gotConnection(conn, authentication):
+    yield conn.start(authentication)
+
+    chan = yield conn.channel(1)
+    yield chan.channel_open()
+
+    yield chan.queue_declare(queue="po_box", durable=True, exclusive=False, auto_delete=False)
+    yield chan.exchange_declare(exchange="sorting_room", type="direct", durable=True, auto_delete=False)
+
+    yield chan.queue_bind(queue="po_box", exchange="sorting_room", routing_key="jason")
+
+    yield chan.basic_consume(queue='po_box', no_ack=True, consumer_tag="testtag")
+
+    def recv_callback(msg, chan, queue):
+        print 'Received: ' + msg.content.body + ' from channel #' + str(chan.id)
+        return (queue.get().addCallback(recv_callback, chan, queue))
+
+    queue = yield conn.queue("testtag")
+    yield (queue.get().addCallback(recv_callback, chan, queue))
+
+    yield chan.basic_cancel("testtag")
+
+    yield chan.channel_close()
+
+    chan0 = yield conn.channel(0)
+
+    yield chan0.connection_close()
+
+    reactor.stop()
+
+
+if __name__ == "__main__":
+    import sys
+    if len(sys.argv) != 2:
+        print "%s path_to_spec" % sys.argv[0]
+        sys.exit(1)
+
+    spec = txamqp.spec.load(sys.argv[1])
+
+    authentication = {"LOGIN": "guest", "PASSWORD": "guest"}
+
+    delegate = TwistedDelegate()
+    d = ClientCreator(reactor, AMQClient, delegate=delegate, vhost="/",
+        spec=spec).connectTCP("localhost", 5672)
+
+    d.addCallback(gotConnection, authentication)
+
+    reactor.run()

=== added file 'examples/pub-con/txamqp_publisher.py'
--- examples/pub-con/txamqp_publisher.py	1970-01-01 00:00:00 +0000
+++ examples/pub-con/txamqp_publisher.py	2009-06-09 22:04:43 +0000
@@ -0,0 +1,43 @@
+from twisted.internet.defer import inlineCallbacks
+from twisted.internet import reactor
+from twisted.internet.protocol import ClientCreator
+from txamqp.protocol import AMQClient
+from txamqp.client import TwistedDelegate
+from txamqp.content import Content
+import txamqp.spec
+
+@inlineCallbacks
+def gotConnection(conn, authentication, body):
+    yield conn.start(authentication)
+
+    chan = yield conn.channel(1)
+    yield chan.channel_open()
+
+    msg = Content(body)
+    msg["delivery mode"] = 2
+    chan.basic_publish(exchange="sorting_room", content=msg, routing_key="jason")
+    
+    yield chan.channel_close()
+
+    chan0 = yield conn.channel(0)
+    yield chan0.connection_close()
+    
+    reactor.stop()
+    
+if __name__ == "__main__":
+    import sys
+    if len(sys.argv) != 3:
+        print "%s path_to_spec content" % sys.argv[0]
+        sys.exit(1)
+
+    spec = txamqp.spec.load(sys.argv[1])
+
+    authentication = {"LOGIN": "guest", "PASSWORD": "guest"}
+
+    delegate = TwistedDelegate()
+    d = ClientCreator(reactor, AMQClient, delegate=delegate, vhost="/",
+        spec=spec).connectTCP("localhost", 5672)
+
+    d.addCallback(gotConnection, authentication, sys.argv[2])
+
+    reactor.run()

=== added directory 'examples/thrift'
=== renamed file 'src/examples/README' => 'examples/thrift/README'
=== renamed file 'src/examples/client.py' => 'examples/thrift/client.py'
=== renamed file 'src/examples/server.py' => 'examples/thrift/server.py'
=== renamed file 'src/examples/shared.thrift' => 'examples/thrift/shared.thrift'
=== renamed file 'src/examples/tutorial.thrift' => 'examples/thrift/tutorial.thrift'
=== modified file 'setup.py'
--- setup.py	2009-05-22 15:29:06 +0000
+++ setup.py	2009-06-09 22:18:42 +0000
@@ -1,16 +1,21 @@
 from distutils.core import setup
 from glob import glob
 
+
 setup(
     name = 'txAMQP',
     version = '0.2',
     author = 'Esteve Fernandez',
     author_email = '[e-mail]',
-    packages = ['txamqp', 'txamqp.contrib', 'txamqp.contrib.thrift'],
+    packages = [
+        'txamqp',
+        'txamqp.contrib',
+        'txamqp.contrib.thrift',
+        ],
     package_dir = {
-        'txamqp': 'src/txamqp',
-        'txamqp.contrib': 'src/txamqp/contrib',
-        'txamqp.contrib.thrift': 'src/txamqp/contrib/thrift',
+        'txamqp': 'txamqp',
+        'txamqp.contrib': 'txamqp/contrib',
+        'txamqp.contrib.thrift': 'txamqp/contrib/thrift',
         },
     url = 'https://launchpad.net/txamqp',
 )

=== renamed directory 'src/specs' => 'specs'
=== removed directory 'src'
=== renamed directory 'src/txamqp' => 'txamqp'