<commit_before>.. _getting_started:


***************
Getting started
***************

Introduction
============

This is the place for people that are new to anapioficeandfire. This tutorial will help you to get started with anapioficeandfire. Note that we won't go too much
into detail, just the most important basic functionality.

Installation
============

At the command line::

    $ pip install anapioficeandfire

First example
============

.. code-block:: python

   import anapioficeandfire

   api = anapioficeandfire.API()

   jon_snow = api.get_character(id=583)
   for title in jon_snow.aliases:
       print(title)
<commit_msg>Trying to fix text for exasmple<commit_after>.. _getting_started:


***************
Getting started
***************

Introduction
============

This is the place for people that are new to anapioficeandfire. This tutorial will help you to get started with anapioficeandfire. Note that we won't go too much
into detail, just the most important basic functionality.

Installation
============

At the command line::

    $ pip install anapioficeandfire

First example
============

.. code-block :: python

   import anapioficeandfire

   api = anapioficeandfire.API()

   jon_snow = api.get_character(id=583)
   for title in jon_snow.aliases:
       print(title)

This example will download all data about the character Jon Snow and print each one of his aliases to the console.

{'fraction_non_alphanumeric': 0.1386347642505278, 'fraction_numerical': 0.00422237860661506, 'mean_word_length': 4.3059701492537314, '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': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6056035', 'n_tokens_mistral': 430, 'n_tokens_neox': 411, 'n_words': 154}