<commit_before>
.. _index:

=======================
cqlengine documentation
=======================

**Users of versions < 0.16, the default keyspace 'cqlengine' has been removed. Please read this before upgrading:** :ref:`Breaking Changes <keyspace-change>`

cqlengine is a Cassandra CQL 3 Object Mapper for Python

:ref:`getting-started`

Download
========

`Github <https://github.com/cqlengine/cqlengine>`_

`PyPi <https://pypi.python.org/pypi/cqlengine>`_

Contents:
=========

.. toctree::
    :maxdepth: 2

    topics/models
    topics/queryset
    topics/columns
    topics/connection
    topics/manage_schemas
    topics/development
    topics/faq

.. _getting-started:

Getting Started
===============

    .. code-block:: python

        #first, define a model
        from cqlengine import columns
        from cqlengine import Model<commit_msg>external resources added to index<commit_after>
.. _index:

=======================
cqlengine documentation
=======================

**Users of versions < 0.16, the default keyspace 'cqlengine' has been removed. Please read this before upgrading:** :ref:`Breaking Changes <keyspace-change>`

cqlengine is a Cassandra CQL 3 Object Mapper for Python

:ref:`getting-started`

Download
========

`Github <https://github.com/cqlengine/cqlengine>`_

`PyPi <https://pypi.python.org/pypi/cqlengine>`_

Contents:
=========

.. toctree::
    :maxdepth: 2

    topics/models
    topics/queryset
    topics/columns
    topics/connection
    topics/manage_schemas
    topics/external_resources
    topics/development
    topics/faq

.. _getting-started:

Getting Started
===============

    .. code-block:: python

        #first, define a model
        from cqlengine import columns
        from cqlengine import Model
{'fraction_non_alphanumeric': 0.17403628117913833, 'fraction_numerical': 0.005668934240362812, 'mean_word_length': 3.7066666666666666, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 9, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7506793', 'n_tokens_mistral': 560, 'n_tokens_neox': 518, 'n_words': 138}