.. vim: set fileencoding=utf-8:
.. -*- coding: utf-8 -*-
.. +--------------------------------------------------------------------------+
   |                                                                          |
   | Licensed under the Apache License, Version 2.0 (the "License");          |
   | you may not use this file except in compliance with the License.         |
   | You may obtain a copy of the License at                                  |
   |                                                                          |
   |     http://www.apache.org/licenses/LICENSE-2.0                           |
   |                                                                          |
   | Unless required by applicable law or agreed to in writing, software      |
   | distributed under the License is distributed on an "AS IS" BASIS,        |
   | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
   | See the License for the specific language governing permissions and      |
   | limitations under the License.                                           |
   |                                                                          |
   +--------------------------------------------------------------------------+

:tocdepth: 4


*******************************************************************************
API
*******************************************************************************

.. warning::

   The Python API for Mimeogram is currently unofficial and should be
   considered unstable. The package is primarily intended for use as a
   command-line tool. Any direct use of the Python modules may break without
   warning in future versions.


Package ``mimeogram``
===============================================================================

A toolkit for exchanging collections of files with Large Language Models
(LLMs). Mimeogram bundles multiple files into a single clipboard-ready document
while preserving directory structure and metadata, making it ideal for code
reviews, project sharing, and LLM interactions.


Module ``mimeogram.acquirers``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.acquirers


Module ``mimeogram.apply``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.apply


Module ``mimeogram.cli``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.cli


Module ``mimeogram.create``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.create


Module ``mimeogram.differences``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.differences


Module ``mimeogram.display``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.display


Module ``mimeogram.edit``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.edit


Module ``mimeogram.exceptions``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.exceptions


Module ``mimeogram.formatters``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.formatters


Module ``mimeogram.interactions``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.interactions


Module ``mimeogram.interfaces``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.interfaces


Module ``mimeogram.parsers``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.parsers


Module ``mimeogram.parts``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.parts


Module ``mimeogram.prompt``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.prompt


Module ``mimeogram.updaters``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.updaters


Package ``mimeogram.fsprotect``
===============================================================================

A subpackage providing filesystem protection features to prevent dangerous
modifications to sensitive paths.


Module ``mimeogram.fsprotect.cache``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.fsprotect.cache


Module ``mimeogram.fsprotect.core``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.fsprotect.core


Module ``mimeogram.fsprotect.home``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.fsprotect.home


Module ``mimeogram.fsprotect.macos``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.fsprotect.macos


Module ``mimeogram.fsprotect.project``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.fsprotect.project


Module ``mimeogram.fsprotect.unix``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.fsprotect.unix


Module ``mimeogram.fsprotect.windows``
-------------------------------------------------------------------------------

.. automodule:: mimeogram.fsprotect.windows