jaraco.net / README

.. -*- restructuredtext -*-

jaraco.net
==========

.. contents::

Status and License
------------------

``jaraco.net`` provides miscellaneous utility functions used across
projects developed by the author.

``jaraco.net`` is written by Jason R. Coombs.  It is licensed under an
`MIT-style permissive license
<http://www.opensource.org/licenses/mit-license.php>`_.

You can install it with ``easy_install jaraco.net``, or from the
`mercurial repository
<http://bitbucket.org/jaraco/jaraco.net/tip/get.zip#egg=jaraco.net-dev>`_ with
``easy_install jaraco.net==dev``.

DNS Forwarding Service
----------------------

``jaraco.net`` includes a DNS forwarding service for Windows. This is
because Microsoft appears to be unable to bind to 6 to 4 and Teredo
addresses with their production DNS Server. After installing
``jaraco.net``, the service executable is available as
`%PYTHON%\Scripts\dns-forward-service.exe`. In addition to the
documented install/uninstall/start/stop commands, it's also possible
to configure a bind address with the -b option. For example::

    dns-forward-service -b 2002:41de:a625::41de:a625 install

The service will be installed and the bind address will be stored in
`HKLM\Software\jaraco.net\DNS Forwarding Service\Listen Address`. Note
that the service must be restarted to recognize an updated bind address.

Changes
-------

2.0
~~~

* Added `jaraco.net.http.MethodRequest`, a urllib2.Request subclass which takes
  a 'method' parameter.
* Consolidated many functions from jaraco.net.http to classes in
  `jaraco.net.http.servers`.
* `whois-bridge` now runs the daemon. A new script `whois-bridge-service` is
  installed on Windows only and specifically invokes the service.
* Removed `cookies` module.
* Refactored `dnsbl` module. Replaced `lookup_host` with `Service.lookup_all`.
  See the module for other interface changes.
* Removed `headers` module (was experimental, now abandoned).
* Removed `html` module (it depends on htmllib, which was deprecated).

1.7
~~~

* Added web-tail command, which "tails" a file, serving the content over
  http to multiple clients (requires CherryPy).

1.6
~~~

* Added jaraco.net.importer, featuring URLImporter.
* Added jaraco.net.http.content.ContentTypeReporter, a cherrypy app to
  report the content type of uploaded content.

1.5.1
~~~~~

* Added directory listing support to serve-local.

1.5
~~~

* Added simple script for creating a directory index (used for legacy
  support).
* Added command script "serve-local" which uses cherrypy to serve the
  current directory on port 8080.

1.4
~~~

* Fixed issue where passing a numeric host to scanner would be detected
  as a named host.
* Fixed HTTP server to work with multipart requests.
* Pickling in http.cache.CachedResponse is now less depedent on the actual
  implementation.
* Added tail module that utilizes CherryPy to serve the tail of a file.
* Fixed issue in setup script with deprecated hgtools usage.
* Using argparse and enabling logging config in ntp module.

1.3
~~~

* Added jaraco.net.devices package. Includes a Manager class for
  retrieving MAC addresses and IP addresses on the host.
* Created jaraco.net.http package (from module of the same name)
* Added jaraco.net.http.caching, an early attempt at providing a
  CachingHandler for urllib2 with HTTP protocol support.
* Added a simple echo server.
* Added http-headers command.

1.2
~~~

* Added function wait_for_host to icmp lib
* Added support for a custom bind address to the DNS Forwarding Service

1.1
~~~

* Added rss module (migrated from jaraco.util)

1.0
~~~

* Initial release.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.