<commit_before>User Guide
==========

What is datacats
----------------

CKAN can be quite difficult to develop and deploy, especially for beginners.
The aim of datacats is to make this easier and bring CKAN within reach for a
much wider audience.

datacats relies on Docker_ to "containerize" the CKAN environment. If you don't
know much about Docker, it doesn't matter. You need to know very little about
it in order to use datacats. If you wish to know more about how
this project works, take a look at :doc:`docker`.

.. _Docker: https://www.docker.com/

Installation
------------

Install Docker
""""""""""""""
You will need to install Docker first:

Linux
#####
Follow the instructions over at the `Docker Docs`_

.. _Docker Docs: https://docs.docker.com/installation/ubuntulinux/

OSX
###
You will need `boot2docker`_, the standard way to get Docker running on your Mac.

.. _boot2docker: https://docs.docker.com/installation/mac/

Windows
#######
Native Windows support is coming soon. For now, you can run datacats inside any Linux
Virtual Machine. Simply install VirtualBox or VMWare, create a Ubuntu VM and
`install Docker`__ on it.

__ `Docker Docs`_

Install datacats
"""""""""""""""""""""
The easiest way to install datacats is with ``pip``. In your shell run: ::

    pip install datacats
<commit_msg>update docs in support of #28<commit_after>User Guide
==========

What is datacats
----------------

CKAN can be quite difficult to develop and deploy, especially for beginners.
The aim of datacats is to make this easier and bring CKAN within reach for a
much wider audience.

datacats relies on Docker_ to "containerize" the CKAN environment. If you don't
know much about Docker, it doesn't matter. You need to know very little about
it in order to use datacats. If you wish to know more about how
this project works, take a look at :doc:`docker`.

.. _Docker: https://www.docker.com/

Installation
------------

Install Docker
""""""""""""""
You will need to install Docker first:

Linux
#####
Follow the instructions over at the `Docker Docs`_. Make sure to install the
Docker-maintained version of Docker, not the official Ubuntu-maintained version
of Docker, which is out-of-date.

.. _Docker Docs: https://docs.docker.com/installation/ubuntulinux/#docker-maintained-package-installation

OSX
###
You will need `boot2docker`_, the standard way to get Docker running on your Mac.

.. _boot2docker: https://docs.docker.com/installation/mac/

Windows
#######
Native Windows support is coming soon. For now, you can run datacats inside any Linux
Virtual Machine. Simply install VirtualBox or VMWare, create a Ubuntu VM and
`install Docker`__ on it.

__ `Docker Docs`_

Install datacats
"""""""""""""""""""""
The easiest way to install datacats is with ``pip``. In your shell run: ::

    pip install datacats

{'fraction_non_alphanumeric': 0.11995753715498939, 'fraction_numerical': 0.0021231422505307855, 'mean_word_length': 3.8910034602076125, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 2, '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': '3252762', 'n_tokens_mistral': 874, 'n_tokens_neox': 808, 'n_words': 378}