Skip to content

Conversation

juleswg23
Copy link
Collaborator

@juleswg23 juleswg23 commented Oct 14, 2025

This PR sets up the development of the package to send emails authored by Quarto, in parallel with the writing of the email for data science guide. Mainly, tt adds core functionality of emailer-lib, as well as a test workflow and an API reference.

Emailer-lib supports the following types of functions:

  • Email Ingress (Conversion to Intermediate Format)
  • Email Egress (Sending)
  • Email Structure Management - IntermediateEmail supports
    • HTML content
    • Plain text content
    • Subject lines
    • Multiple recipients
    • Inline attachments (images embedded in HTML)
    • External attachments (TODO)

CI & Testing

  • Added a new test-emailer-lib job to .github/workflows/ci.yml, which runs tests for emailer-lib.
  • Updated the main CI workflow to only trigger on pull requests and improved the docs build step to use quartodoc for API documentation generation.

Documentation & API Reference

  • Expanded _quarto.yml to add a quartodoc section, generating a structured API reference.
  • Added a README.md for emailer-lib, detailing its purpose, features, usage examples, and contribution guidelines.

Project Structure

  • Added a top-level import structure in __init__.py, making all major functions and classes available directly from the package.
  • Added a Makefile to emailer-lib for running tests and updating test snapshots easily.

Copy link

github-actions bot commented Oct 14, 2025

PR Preview Action v1.6.2

🚀 View preview at
https://posit-dev.github.io/email-for-data-science/pr-preview/pr-4/

Built to branch gh-pages at 2025-10-20 21:05 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@juleswg23 juleswg23 changed the title Shell of the package to send quarto (and other serialized) emails First draft of the package to send quarto (and other serialized) emails Oct 16, 2025
@juleswg23 juleswg23 merged commit 4c2da59 into main Oct 21, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant