Skip to content

Commit

Permalink
doc/setup.py updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mreiferson committed Oct 31, 2012
1 parent 4be09fd commit aad900a
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
dist
*.pyc
pynsq.egg-info
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
## pynsq

`pynsq` is a Python NSQ client library.
`pynsq` is the official Python client library for [NSQ][nsq].

It provides a high-level reader library for building consumers and two low-level modules for both
sync and async communication over the NSQ protocol (if you wanted to write your own high-level
functionality).
sync and async communication over the [NSQ][nsq] protocol (if you wanted to write your own
high-level functionality).

The async module is built on top of the [Tornado IOLoop][tornado] and as such requires `tornado` be
installed:

`$ pip install tornado`
$ pip install tornado

### Reader

Expand Down Expand Up @@ -91,4 +91,5 @@ r = nsq.Reader(all_tasks, lookupd_http_addresses=['http://127.0.0.1:4161'],
nsq.run()
```

[nsq]: https://github.com/bitly/nsq
[tornado]: https://github.com/facebook/tornado
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
keywords='python nsq',
author='Matt Reiferson',
author_email='snakes@gmail.com',
url='http://github.com/bitly/nsq/pynsq',
download_url='https://github.com/downloads/bitly/nsq/pynsq-%s.tar.gz' % version,
url='http://github.com/bitly/pynsq',
download_url='https://github.com/downloads/bitly/pynsq/pynsq-%s.tar.gz' % version,
packages=['nsq'],
include_package_data=True,
zip_safe=True,
Expand Down

0 comments on commit aad900a

Please sign in to comment.