<commit_before>Welcome to bourne documentation!
==================================

Bourne provides smart Python object to json conversion.


QuickStart
==========

Example::

    from bourne import BourneMixin


    class User(BourneMixin):
        first_name = 'John'
        last_name = 'Matrix'
        email = '<EMAIL>'
        protected_property = 'this value is not included in json'

        def attributes(self):
            return ['first_name', 'last_name', 'email']

    user = User()<commit_msg>updated quickstart<commit_after>Welcome to bourne documentation!
==================================

Bourne provides smart Python object to json conversion.


QuickStart
==========

1. Make your class use BourneMixin
2. Define attributes() method and make at return a list of property names

Example::

    from bourne import BourneMixin


    class User(BourneMixin):
        first_name = 'John'
        last_name = 'Matrix'
        email = '<EMAIL>'
        protected_property = 'this value is not included in json'

        def attributes(self):
            return ['first_name', 'last_name', 'email']

    user = User()
{'fraction_non_alphanumeric': 0.15207780725022105, 'fraction_numerical': 0.0017683465959328027, 'mean_word_length': 3.2238805970149254, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, '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': '1300957', 'n_tokens_mistral': 311, 'n_tokens_neox': 290, 'n_words': 103}