<commit_before>"""
API Reference
-------------
"""
from __future__ import absolute_import, division, print_function, unicode_literals

import os
import shutil
import sys
import tempfile
from textwrap import dedent

from os.path import dirname, isdir, realpath


__version__ = '1.0.1-dev'

<commit_msg>Add a tutorial to the documentation<commit_after>"""
Tutorial
========

Instantiate the :py:class:`~filesystem_tree.FilesystemTree` class:

>>> from filesystem_tree import FilesystemTree
>>> ft = FilesystemTree()

Now make files!

>>> ft.mk(('greetings/program.txt', 'Greetings, program!'))

You can get the full absolute path of the file you created with
:py:func:`~filesystem_tree.FilesystemTree.resolve`:

>>> filepath = ft.resolve('greetings/program.txt')

Make directories like so:

>>> ft.mk('my/directory/')

When you're done, clean up with :py:func:`~filesystem_tree.FilesystemTree.remove`:

>>> ft.remove()


API Reference
=============
"""
from __future__ import absolute_import, division, print_function, unicode_literals

import os
import shutil
import sys
import tempfile
from textwrap import dedent

from os.path import dirname, isdir, realpath


__version__ = '1.0.1-dev'


{'fraction_non_alphanumeric': 0.13372582001682085, 'fraction_numerical': 0.005046257359125316, 'mean_word_length': 5.4324324324324325, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 21, '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': '1632710', 'n_tokens_mistral': 380, 'n_tokens_neox': 366, 'n_words': 111}