Merge pull request #24 from oskopek/release-v0.1.0

Release v0.1.0

NOTICE.rst

@@ -7,7 +7,30 @@ All rights reserved.
 
 All Authors and Contributors are named in the AUTHORS.rst file.
 
-Used libraries
-==============
+Used Third Party Code
+=====================
 
-None.
+SleekXMPP
+=========
+
+```
+Copyright (c) 2010 Nathanael C. Fritz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+```

README

@@ -4,9 +4,11 @@ CryptoIM
 
 .. image:: https://travis-ci.org/oskopek/CryptoIM.png?branch=develop
     :target: https://travis-ci.org/oskopek/CryptoIM
+    :alt: TravisCI
 
 .. image:: https://coveralls.io/repos/oskopek/CryptoIM/badge.png?branch=develop
     :target: https://coveralls.io/r/oskopek/CryptoIM?branch=develop
+    :alt: Coveralls
 
 .. image:: https://pypip.in/v/CryptoIM/badge.png
     :target: https://pypi.python.org/pypi/CryptoIM/
@@ -20,18 +22,76 @@ CryptoIM
     :target: https://pypi.python.org/pypi/CryptoIM/
     :alt: License
 
-A crypto-aware instant messenger written in Python out of sheer fun.
+A secure* instant messenger written in Python out of sheer fun.
+
+\* not really secure (at least not yet)
+
+Building
+========
+
+1. **Build**: ``python setup.py build`` and ``sudo python setup.py install``
+
+2. To **run**: ``python main.py``
+
+3. To run **unit tests**: ``python setup.py nosetests``
+
+4. To **clean**, run: ``python setup.py clean --all``
+
+5. To **edit** connection options, edit the ``main.cfg`` file.
+
+Building on Linux
+=================
+
+* Make sure to **install** these packages using your package manager: ``python`` and ``python-setuptools``
+
+* Follow steps 1., 2. and 5. from **Building**
+
+Building on Windows
+===================
+
+* **Install** `Python <http://www.python.org/download/releases/3.3.3/#download>`_ and `Setuptools <https://pypi.python.org/pypi/setuptools#windows>`_.
+
+* Follow steps 1., 2. and 5. from **Building**
+
+Contributing
+============
+
+**Everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by translating to a new language
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by closing `issues <https://github.com/oskopek/CryptoIM/issues>`_
+* by reviewing patches
 
 Info
 ====
 
 CryptoIM uses `semantic versioning <http://semver.org/>`_ and branching model similar to `this <http://nvie.com/posts/a-successful-git-branching-model/>`_.
 
-Building
-========
+Submitting an Issue
+===================
 
-* **Build**: ``python setup.py build`` and ``sudo python setup.py install``
+We use the `GitHub issue tracker <https://github.com/oskopek/CryptoIM/issues>`_ to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a `Gist <https://gist.github.com/>`_
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your Java version and operating system.
 
-* To run **unit tests**: ``python setup.py nosetests``
+Submitting a Pull Request
+=========================
 
-* To **clean**, run: ``python setup.py clean --all``
+1. `Fork the repository <http://help.github.com/fork-a-repo/>`_.
+2. `Create a topic branch <http://learn.github.com/p/branching.html>`_.
+3. Implement your feature or bug fix.
+4. Run ``python setup.py nosetests``. If the tests fail, return to step 3.
+5. If applicable, add tests for your feature or bug fix.
+6. Add, commit, and push your changes.
+7. `Submit a pull request <http://help.github.com/send-pull-requests/>`_.

README.rst

@@ -4,9 +4,11 @@ CryptoIM
 
 .. image:: https://travis-ci.org/oskopek/CryptoIM.png?branch=develop
     :target: https://travis-ci.org/oskopek/CryptoIM
+    :alt: TravisCI
 
 .. image:: https://coveralls.io/repos/oskopek/CryptoIM/badge.png?branch=develop
     :target: https://coveralls.io/r/oskopek/CryptoIM?branch=develop
+    :alt: Coveralls
 
 .. image:: https://pypip.in/v/CryptoIM/badge.png
     :target: https://pypi.python.org/pypi/CryptoIM/
@@ -20,18 +22,76 @@ CryptoIM
     :target: https://pypi.python.org/pypi/CryptoIM/
     :alt: License
 
-A crypto-aware instant messenger written in Python out of sheer fun.
+A secure* instant messenger written in Python out of sheer fun.
+
+\* not really secure (at least not yet)
+
+Building
+========
+
+1. **Build**: ``python setup.py build`` and ``sudo python setup.py install``
+
+2. To **run**: ``python main.py``
+
+3. To run **unit tests**: ``python setup.py nosetests``
+
+4. To **clean**, run: ``python setup.py clean --all``
+
+5. To **edit** connection options, edit the ``main.cfg`` file.
+
+Building on Linux
+=================
+
+* Make sure to **install** these packages using your package manager: ``python`` and ``python-setuptools``
+
+* Follow steps 1., 2. and 5. from **Building**
+
+Building on Windows
+===================
+
+* **Install** `Python <http://www.python.org/download/releases/3.3.3/#download>`_ and `Setuptools <https://pypi.python.org/pypi/setuptools#windows>`_.
+
+* Follow steps 1., 2. and 5. from **Building**
+
+Contributing
+============
+
+**Everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by translating to a new language
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by closing `issues <https://github.com/oskopek/CryptoIM/issues>`_
+* by reviewing patches
 
 Info
 ====
 
 CryptoIM uses `semantic versioning <http://semver.org/>`_ and branching model similar to `this <http://nvie.com/posts/a-successful-git-branching-model/>`_.
 
-Building
-========
+Submitting an Issue
+===================
 
-* **Build**: ``python setup.py build`` and ``sudo python setup.py install``
+We use the `GitHub issue tracker <https://github.com/oskopek/CryptoIM/issues>`_ to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a `Gist <https://gist.github.com/>`_
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your Java version and operating system.
 
-* To run **unit tests**: ``python setup.py nosetests``
+Submitting a Pull Request
+=========================
 
-* To **clean**, run: ``python setup.py clean --all``
+1. `Fork the repository <http://help.github.com/fork-a-repo/>`_.
+2. `Create a topic branch <http://learn.github.com/p/branching.html>`_.
+3. Implement your feature or bug fix.
+4. Run ``python setup.py nosetests``. If the tests fail, return to step 3.
+5. If applicable, add tests for your feature or bug fix.
+6. Add, commit, and push your changes.
+7. `Submit a pull request <http://help.github.com/send-pull-requests/>`_.

cryptoim/__init__.py

@@ -14,6 +14,6 @@
    limitations under the License.
 """
 
-from cryptoim import decryptor_core, encryptor_core, const, common
+from cryptoim import decryptor_core, encryptor_core, const, common, xmpp, cli, key_exchange
 
-__all__ = ["decryptor_core", "encryptor_core", "const", "common", ]
+__all__ = ['decryptor_core', 'encryptor_core', 'const', 'common', 'xmpp', 'cli', 'key_exchange', ]