README

Twitter common libraries for python and the jvm

== Installation ==

Building requires:
+ jdk 1.6+
+ python 2.6+

The build tool is custom and hosted in the repository itself.

== Usage ==

To build all jvm code and run all tests:
$ ./pants goal test tests/{java,scala}/com/twitter/common::

Likewise for python commons:
$ ./pants tests/python/twitter/common/:all

And for the pants build tool itself:
$ ./pants tests/python/twitter/pants:all

To get help on pants:
$ ./pants help

Read more http://twitter.github.com/commons/

TODO(John Sirois): migrate pants documentation to the public wiki

== Usage questions and feature discussions ==

Please check the archives for twitter-commons@googlegroups.com then fire
away if the question has not been addressed.

== Reporting bugs ==

Please use the github issue tracker for twitter commons at:
https://github.com/twitter/commons/issues

== Copyright and License ==

Copyright 2011 Twitter, Inc.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this work except in compliance with the License.
   You may obtain a copy of the License in the LICENSE file, or at:

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.