<commit_before>Installing Modules
==================

Some of the modules in this repository come with Ansible out of the box. Those
modules are considered "stable".

There are other modules in this repository that do not yet come with Ansible out
of the box. Thos modules are considered "unstable".

In the tutorials on this site, we generally use only modules that are stable.

There is a chance, however, that you might need to use unstable modules though.
In particular, you'll encounter this if you need to test something or if you
just can't wait for a module to become stable.

There are a couple ways to install these modules on your system.

In your Ansible install directory
---------------------------------

Different systems can put Ansible in different locations. The recommended way
to install Ansible however (via `pip`) puts the modules here

  * /usr/local/lib/PYTHON_VERSION/site-packages/ansible/modules/extras/network/f5/

To install the F5 modules in this repository, you can copy the contents of
the `library/` directory we provide, into the location mentioned above.

In a relative location
----------------------

Ansible also allows you to put modules in a location that is relative to where
the project you are working on is.

This is accomplished by ensuring that an `ansible.cfg` file exists in the
directory that you run Ansible from.

Inside the `ansible.cfg` file, you can put the following

.. code-block:: yaml

   [defaults]
   library=./library
<commit_msg>Update installing_modules.rst<commit_after>Installing Modules
==================

Some of the modules in this repository come with Ansible out of the box. Those
modules are considered "stable".

There are other modules in this repository that do not yet come with Ansible out
of the box. Thos modules are considered "unstable".

In the tutorials on this site, we generally use only modules that are stable.

There is a chance, however, that you might need to use unstable modules though.
In particular, you'll encounter this if you need to test something or if you
just can't wait for a module to become stable.

There are a couple ways to install these modules on your system.

In your Ansible install directory
---------------------------------

Different systems can put Ansible in different locations. The recommended way
to install Ansible however (via `pip`) puts the modules here

  * /usr/local/lib/PYTHON_VERSION/site-packages/ansible/modules/extras/network/f5/

To install the F5 modules in this repository, you can copy the contents of
the `library/` directory we provide, into the location mentioned above.

on MacOSX, the following location can be used for the modules:
  * /Library/Frameworks/Python.framework/Versions/[PYTHON_VERSION]/lib/python[PYTHON_VERSION]/site-packages/ansible/modules/extras/network/f5

In a relative location
----------------------

Ansible also allows you to put modules in a location that is relative to where
the project you are working on is.

This is accomplished by ensuring that an `ansible.cfg` file exists in the
directory that you run Ansible from.

Inside the `ansible.cfg` file, you can put the following

.. code-block:: yaml

   [defaults]
   library=./library

{'fraction_non_alphanumeric': 0.09258104738154614, 'fraction_numerical': 0.0015586034912718205, 'mean_word_length': 3.623919308357349, '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': '1987427', 'n_tokens_mistral': 831, 'n_tokens_neox': 788, 'n_words': 443}