<commit_before>.. Mongu documentation master file, created by
   sphinx-quickstart on Thu Apr 17 10:14:31 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Introducing to Mongu
=====================
**Mongu** is yet another Python Object-Document Mapper on top of ``PyMongo``. It's lightweight, intuitive to use and easy to understand.

- If you want **control**.
- If you really care about **performance**.
- If those **heavy and slow layers** have nothing or more than you need.

Well, **Mongu** maybe the one for you.

You are the only one who knows what you reall need.

Therefor **Mongu** does nothing but a skeleton for you to fill.

Actually, if you have ever tried to write your own ODM, you may already implemented parts of **Mongu** :D


You don't need user-guides but examples to get started
========================================================

We don't assume you are stupid, here we go::

    from mongu import set_database, register_model, Model

    set_database('test') # always set database before anything else

**Model definition**::

    @register_model<commit_msg>add `Fork me on GitHub` ribbon to the doc<commit_after>.. Mongu documentation master file, created by
   sphinx-quickstart on Thu Apr 17 10:14:31 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. raw:: html

  <a href="http://github.com/tevino/mongu">
    <img style="position: absolute; top: 0; right: 0; border: 0; max-width: 149px;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub">
  </a>

Introducing to Mongu
=====================
**Mongu** is yet another Python Object-Document Mapper on top of ``PyMongo``. It's lightweight, intuitive to use and easy to understand.

- If you want **control**.
- If you really care about **performance**.
- If those **heavy and slow layers** have nothing or more than you need.

Well, **Mongu** maybe the one for you.

You are the only one who knows what you reall need.

Therefor **Mongu** does nothing but a skeleton for you to fill.

Actually, if you have ever tried to write your own ODM, you may already implemented parts of **Mongu** :D


You don't need user-guides but examples to get started
========================================================

We don't assume you are stupid, here we go::

    from mongu import set_database, register_model, Model

    set_database('test') # always set database before anything else

**Model definition**::

    @register_model
{'fraction_non_alphanumeric': 0.14274779946421737, 'fraction_numerical': 0.014159969383849981, 'mean_word_length': 4.291497975708502, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 6, 'https://': 1, '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': '2303415', 'n_tokens_mistral': 786, 'n_tokens_neox': 715, 'n_words': 350}