Hacking
=========


As we have so far a tight integrated group, we are typically not
forking the repository, but cloning it directly. Members are than able
to work on the clones. We may change this in case we see need for forks.

Contributing
------------

.. include:: ../../CONTRIBUTING

Requirements file
-----------------

There are two primary requirements files:

- ``requirements-open.txt` are unbounded requirements to be used during development and testing
- ``requirements.txt` are the frozen requirements generated by ``pip freeze``. This should be updated for every release

Editor
------

Use PyCharam.

We made bad experience with people using editors other than emacs, vi, and PyCharm.
When working on Windows make sure your editor handles newlines properly with git.

Documentation
-------------

Creating the documentation with sphinx is easy

.. prompt:: bash

    pip install -r requirements-doc.txt
    make doc

View the documentation

.. prompt:: bash

   make view

Testing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Tox
~~~~~

We assume that you checked out the newest version from cloudmesh client
and base from source and that they are located in::

  ~/github/cloudmesh/base
  ~/github/cloudmesh/client

We assume you have tox installed

.. prompt:: bash

   pip install tox

in the client directory you call tox

.. prompt:: bash

  cd ~/github/cloudmesh/client
  tox

Nosetests
~~~~~~~~~~

Nose tests can be started with

.. prompt:: bash

  nosetests

Individual nosetests can be started with (here an example frm test_list.py
is used):

.. prompt:: bash

    pip install -U .; nosetests -v --nocapture  tests/test_list.py:Test_list.test_001


Git
----

Closing Issues via Commit Messages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To close an issue on github issues, you can use it in your commit messages as follows

.. prompt:: bash

git commit -m "Fix problem xyz, fixes #12"


SSH keys
^^^^^^^^^

You can get a list of public ssh keys in plain text format by visiting:

https://github.com/{user}.keys
  
Sheetsheet
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* https://github.com/tiimgreen/github-cheat-sheet
* https://training.github.com/kit/downloads/github-git-cheat-sheet.pdf
* http://byte.kde.org/~zrusin/git/git-cheat-sheet.svg
* http://www.emoji-cheat-sheet.com

Empty Commits
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Commits can be pushed with no code changes by adding --allow-empty:

.. prompt:: bash

    git commit -m "Big-ass commit" --allow-empty


Styled Git Log
^^^^^^^^^^^^^^^^^

.. prompt:: bash
   
   git log --all --graph --pretty=format:'%Cred%h%Creset -%C(auto)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --date=relative


Tags
^^^^^

Tags are only created by Gregor von Laszewski.

Create a tag. Always use x.y.z

.. prompt:: bash

   make tag

Remove a tag

.. prompt:: bash

   make rmtag


Publish on Github
^^^^^^^^^^^^^^^^^

The documentation is only pushed by  Gregor von
Laszewski.

.. prompt:: bash

    make publish

Logging
^^^^^^^^

::

    from cloudmesh_client.common.LogUtil import LogUtil

    log = LogUtil.get_logger()
    log.info("Cloud: " + cloud + ", Arguments: " + str(arguments))