Metadata-Version: 2.4
Name: tutor-contrib-mailpit
Version: 0.1.4
Summary: A Tutor plugin for local email testing
Home-page: https://github.com/Abstract-Tech/tutor-contrib-mailpit
Author: Abstract-Technology GmbH
Author-email: support@abstract-technology.de
Maintainer: Emad Ehsanrad
Maintainer-email: e.ehsanrad@abstract-technology.de
License: AGPLv3
Keywords: tutor,plugin,mailpit,openedx
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: tutor>=14.0.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: maintainer
Dynamic: maintainer-email
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

Local email testing plugin for tutor
====================================

This is a plugin for `Tutor <https://docs.tutor.edly.io>`_ for more convenient email testing using `Mailpit <https://github.com/axllent/mailpit>`_.

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

.. code-block:: bash

    pip install tutor-contrib-mailpit

Usage
-----

Enable the plugin:

.. code-block:: bash

    tutor plugins enable mailpit

Save the changes in the environment:

.. code-block:: bash

    tutor config save

Run the environment:

.. code-block:: bash

    tutor dev start -d

Check the mailpit interface at http://localhost:8025 for outgoing emails.

Note that the plugin only works in the dev environment.

License
-------

This software is licensed under the terms of the GNU Affero General Public License v3 (AGPLv3). See the `LICENSE.txt <./LICENSE.txt>`_ file for details.
