<commit_before>===============================
How to develop the PyBonita lib
===============================

Test case
=========

With bonita Server
------------------

.. code:: python
    

    from pybonita.tests import TestWithBonitaServer

    class TestBidonA(TestWithBonitaServer):
        
        def testA(self):
            BonitaServer.use('localhost', 9090, 'restuser', 'restbpm')
            <commit_msg>adds some doc about how to develop<commit_after>===============================
How to develop the PyBonita lib
===============================

Guideline
=========

- get_something methods return None if nothing found
- method header must include docstring with something like this :

.. code:: python

    def my_kick_ass_method(self,param1,param2,param3=default_value,**kwargs):
        """ Short description of the method in one line.
        
        Longer description. Could include some specific behaviors description.
        
        Description of usable extra paramaters if any (those given in kwargs).
        
        :param param1: description of param1, also set the default value if any
        :type param1: type of param1 (either standard as int, str or class as BonitaUser)
        :raise ExceptionClass: when the exception may be raised
        
        """
        pass # my method code

Test case
=========

With bonita Server
------------------

.. code:: python
    

    from pybonita.tests import TestWithBonitaServer

    class TestBidonA(TestWithBonitaServer):
        
        def testA(self):
            BonitaServer.use('localhost', 9090, 'restuser', 'restbpm')
            
{'fraction_non_alphanumeric': 0.17137592137592136, 'fraction_numerical': 0.009213759213759214, 'mean_word_length': 2.710706150341686, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2864517', 'n_tokens_mistral': 426, 'n_tokens_neox': 403, 'n_words': 144}