Skip to content

Commit

Permalink
Remove EmailPublisher (#196)
Browse files Browse the repository at this point in the history
  • Loading branch information
zeynepgultugaydemir authored Jan 14, 2025
1 parent 3e7ad90 commit 83d0f2a
Show file tree
Hide file tree
Showing 6 changed files with 2 additions and 191 deletions.
36 changes: 0 additions & 36 deletions docs/source/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,6 @@ first you need to have a Bloomberg subscription. Then you need to have
the BLPAPI running somewhere. Then you need to specify where the API is
running by specifying its host and port.

**email_templates_directory (optional)**

``settings.json``:

.. code:: json
"email_templates_directory": "input/email_templates"
Setting used by the ``EmailPublisher``. Email templates are HTML
templates with placeholders (e.g. {{user.name}}).

**output_directory**

``settings.json``:
Expand All @@ -141,28 +130,3 @@ templates with placeholders (e.g. {{user.name}}).
A relative path to the directory into which different components will
put their output (e.g. generated tearsheets).

**smtp (optional)**

``settings.json``:

.. code:: json
"smtp": {
"host": "smtp.server.pl",
"port": 587,
"domain": "SOME_DOMAIN",
"tls": true,
"sender": "[email protected]"
}
``secret_settings.json``:

.. code:: json
"smtp": {
"username": "sample_user",
"password": "VeryStrong P4ssw0rd with s0me Polish special characters (to confuse the hacker)"
}
SMTP settings used by the ``EmailPublisher``.
3 changes: 1 addition & 2 deletions docs/source/document_utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,4 @@ document_utils
document_exporting.pdf_exporter.PDFExporter
document_exporting.html_exporter.HTMLExporter
excel.excel_importer.ExcelImporter
excel.excel_exporter.ExcelExporter
email_publishing.email_publisher.EmailPublisher
excel.excel_exporter.ExcelExporter
3 changes: 1 addition & 2 deletions docs/source/reference/structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -229,8 +229,7 @@ Documents utils

The package contains the following tools: - *document_exporting* -
templates, styles and components used to export the results and save
them as files - *email_publishing* - creation and sending emails from
given templates - *excel* - exporting and importing data to/from Excel
them as files - *excel* - exporting and importing data to/from Excel
files

Indicators
Expand Down
13 changes: 0 additions & 13 deletions qf_lib/documents_utils/email_publishing/__init__.py

This file was deleted.

137 changes: 0 additions & 137 deletions qf_lib/documents_utils/email_publishing/email_publisher.py

This file was deleted.

1 change: 0 additions & 1 deletion qf_lib/tests/unit_tests/config/test_settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
"port": 8194
},
"input_directory": "input",
"email_templates_directory": "input/email_templates",
"logo_path": "input/images/cern_logo.png",
"output_directory": "output",
"logs_directory": "logs",
Expand Down

0 comments on commit 83d0f2a

Please sign in to comment.