Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #81

Merged
merged 10 commits into from
Jan 16, 2025
Merged

Update README.md #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
08c7fc8
Update README.md
weiiwang01 Dec 19, 2024
3efcf71
Update README.md
weiiwang01 Jan 8, 2025
eb8b32f
Update README.md
weiiwang01 Jan 10, 2025
69ec0df
Apply suggestions from code review
weiiwang01 Jan 10, 2025
4d8bfad
Update copyright
weiiwang01 Jan 13, 2025
5c5cd21
Merge remote-tracking branch 'origin/update-readme' into update-readme
weiiwang01 Jan 13, 2025
5b5ebf3
Add .licenserc.yaml
weiiwang01 Jan 13, 2025
283a559
Update .licenserc.yaml
weiiwang01 Jan 13, 2025
5b45480
Remove .licenserc.yaml
weiiwang01 Jan 13, 2025
6ebf95c
Update smtp.py
weiiwang01 Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 24 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,40 +5,37 @@

# SMTP Integrator Operator

A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators)
deploying and managing a SMTP Integrator on Kubernetes and bare metal. SMTP
is an Internet standard communication protocol for email transmission.

This charm simplifies configuration of SMTP client by providing a single point
of configuration for all the requirers using the same SMTP server. It can be
deployed on many different Kubernetes platforms, from [MicroK8s](https://microk8s.io)
to [Charmed Kubernetes](https://ubuntu.com/kubernetes), public cloud Kubernetes
offerings and virtual machines or bare metal.

As such, the charm makes it easy to manage and propagate SMTP configuration, while
giving the freedom to deploy on the substrate of their choice.
A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators)
for deploying and managing an SMTP integrator on Kubernetes or bare metal.
The SMTP integrator provides SMTP connection information to other charms
that require `smtp` integration, facilitating the email-sending capabilities
of those charms.

For DevOps or SRE teams this charm will make operating any charm requiring SMTP
authentication simple and straightforward through Juju's clean interface.

erinecon marked this conversation as resolved.
Show resolved Hide resolved
## Project and community
For information about how to deploy, integrate, and manage this charm,
see the Official [SMTP Integrator Operator Documentation](https://charmhub.io/smtp-integrator).

The SMTP Integrator Operator is a member of the Ubuntu family. It's an open source
project that warmly welcomes community projects, contributions, suggestions,
fixes and constructive feedback.
* [Code of conduct](https://ubuntu.com/community/code-of-conduct)
* [Get support](https://discourse.charmhub.io/)
* [Join our online chat](https://chat.charmhub.io/charmhub/channels/charm-dev)
* [Contribute](https://charmhub.io/smtp-integrator/docs/how-to-contribute)
Thinking about using the SMTP Integrator Operator for your next project? [Get in touch](https://chat.charmhub.io/charmhub/channels/charm-dev)!
## Get started

## Contributing to this documentation
You can follow the tutorial [here](https://charmhub.io/smtp-integrator/docs/tutorial-getting-started).

erinecon marked this conversation as resolved.
Show resolved Hide resolved
Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions and constructive feedback on our documentation. Our documentation is hosted on the [Charmhub forum](https://charmhub.io/smtp-integrator/docs) to enable easy collaboration. Please use the "Help us improve this documentation" links on each documentation page to either directly change something you see that's wrong, ask a question, or make a suggestion about a potential change via the comments section.
### Basic operations

If there's a particular area of documentation that you'd like to see that's missing, please [file a bug](https://github.com/canonical/smtp-integrator-operator/issues).
The smtp-integrator charm is a charm intended to be used to provide SMTP
connection information via the `smtp` Juju integration to other charms.
The smtp-integrator charm is first configured with the desired SMTP connection
information, and any charm that integrates with the smtp-integrator
charm can obtain the configured SMTP connection information via the
`smtp` Juju integration.

---
## Learn more
* [Read more](https://charmhub.io/smtp-integrator)
* [SAML specification](https://www.oasis-open.org/standard/smtp/)
* [Troubleshooting](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)

For further details,
[see the charm's detailed documentation](https://charmhub.io/smtp-integrator/docs).
## Project and community
* [Issues](https://github.com/canonical/smtp-integrator-operator/issues)
* [Contributing](https://charmhub.io/smtp-integrator/docs/how-to-contribute)
* [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
2 changes: 1 addition & 1 deletion charmcraft.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.
type: charm
bases:
Expand Down
2 changes: 1 addition & 1 deletion config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

options:
Expand Down
2 changes: 1 addition & 1 deletion generate-src-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env bash

# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

lazydocs --no-watermark --output-path src-docs src/*
4 changes: 2 additions & 2 deletions lib/charms/smtp_integrator/v0/smtp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# Licensed under the Apache2.0. See LICENSE file in charm source for details.

"""Library to manage the integration with the SMTP Integrator charm.
Expand Down Expand Up @@ -68,7 +68,7 @@ def _on_config_changed(self, _) -> None:

# Increment this PATCH version before using `charmcraft publish-lib` or reset
# to 0 if you are raising the major API version
LIBPATCH = 13
LIBPATCH = 14

PYDEPS = ["pydantic>=2"]

Expand Down
2 changes: 1 addition & 1 deletion metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.
name: smtp-integrator
display-name: SMTP Integrator
Expand Down
2 changes: 1 addition & 1 deletion src/charm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env python3

# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

"""SMTP Integrator Charm service."""
Expand Down
2 changes: 1 addition & 1 deletion src/charm_state.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env python3

# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

"""Module defining the CharmState class which represents the state of the SMTP Integrator charm."""
Expand Down
2 changes: 1 addition & 1 deletion tests/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.
2 changes: 1 addition & 1 deletion tests/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

"""Fixtures for charm tests."""
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.
2 changes: 1 addition & 1 deletion tests/integration/any_charm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

# pylint: disable=import-error,consider-using-with,no-member
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

"""Fixtures for the SMTP Integrator charm integration tests."""
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/test_charm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/usr/bin/env python3
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

"""SMTP Integrator charm integration tests."""
Expand Down
2 changes: 1 addition & 1 deletion tests/interface/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.
2 changes: 1 addition & 1 deletion tests/interface/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

"""Fixtures for charm-relation-interfaces tests."""
Expand Down
2 changes: 1 addition & 1 deletion tests/interface/test_smtp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

"""SMTP interface tests."""
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.
2 changes: 1 addition & 1 deletion tests/unit/test_charm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

"""Unit tests."""
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/test_charm_state.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

"""CharmState unit tests."""
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/test_library_smtp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

"""SMTP library unit tests"""
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2024 Canonical Ltd.
# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

[tox]
Expand Down
Loading