<commit_before>Configuring
===========

You'll need to configure Todoman before the first usage, using its simple
ini-like configuration file.

Configuration File
------------------

The configuration file should be placed in
``$XDG_CONFIG_DIR/todoman/config.py``. ``$XDG_CONFIG_DIR`` defaults to
``~/.config`` is most situations, so this will generally be
``~/.config/todoman/config.py``.

.. include:: confspec.tmp

Sample configuration
--------------------

The below example should serve as a reference. It will read ics files from any
directory inside ``~/.local/share/calendars/``, uses the ISO-8601 date format,
and set the due date for new todos in 48hs.

.. literalinclude:: ../../config.py.sample
  :language: python

Color and displayname
---------------------

- You can set a color for each task list by creating a ``color`` file containing
  a color code in the hex format: ``#RRGGBB``.
- A file named ``displayname`` indicates how the task list should be named and
  is needed when there are multiple directories sharing a name, e.g.: when using
  multiple $CloudInstances. The default is the directory name.<commit_msg>Fix typo in configuration docs<commit_after>Configuring
===========

You'll need to configure Todoman before the first usage, using its simple
ini-like configuration file.

Configuration File
------------------

The configuration file should be placed in
``$XDG_CONFIG_HOME/todoman/config.py``. ``$XDG_CONFIG_HOME`` defaults to
``~/.config`` is most situations, so this will generally be
``~/.config/todoman/config.py``.

.. include:: confspec.tmp

Sample configuration
--------------------

The below example should serve as a reference. It will read ics files from any
directory inside ``~/.local/share/calendars/``, uses the ISO-8601 date format,
and set the due date for new todos in 48hs.

.. literalinclude:: ../../config.py.sample
  :language: python

Color and displayname
---------------------

- You can set a color for each task list by creating a ``color`` file containing
  a color code in the hex format: ``#RRGGBB``.
- A file named ``displayname`` indicates how the task list should be named and
  is needed when there are multiple directories sharing a name, e.g.: when using
  multiple $CloudInstances. The default is the directory name.
{'fraction_non_alphanumeric': 0.14678899082568808, 'fraction_numerical': 0.005242463958060288, 'mean_word_length': 3.2803738317757007, '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': '7216106', 'n_tokens_mistral': 624, 'n_tokens_neox': 600, 'n_words': 283}