Skip to content

docs: update docstrings of apt and snap libs with deprecation notice #168

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

Merged
james-garner-canonical merged 1 commit into from
Oct 8, 2025
Merged

docs: update docstrings of apt and snap libs with deprecation notice #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 14 additions & 2 deletions lib/charms/operator_libs_linux/v0/apt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,19 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Abstractions for the system's Debian/Ubuntu package information and repositories.
"""Legacy Charmhub-hosted snap library, deprecated in favour of ``charmlibs.apt``.

WARNING: This library is deprecated and will no longer receive feature updates or bugfixes.
``charmlibs.apt`` version 1.0 is a bug-for-bug compatible migration of this library.
Add 'charmlibs-apt~=1.0' to your charm's dependencies, and remove this Charmhub-hosted library.
Then replace `from charms.operator_libs_linux.v0 import apt` with `from charmlibs import apt`.
Read more:
- https://documentation.ubuntu.com/charmlibs
- https://pypi.org/project/charmlibs-apt

---

Abstractions for the system's Debian/Ubuntu package information and repositories.

This module contains abstractions and wrappers around Debian/Ubuntu-style repositories and
packages, in order to easily provide an idiomatic and Pythonic mechanism for adding packages and/or
Expand Down Expand Up @@ -133,7 +145,7 @@

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

PYDEPS = ["opentelemetry-api"]

Expand Down
16 changes: 14 additions & 2 deletions lib/charms/operator_libs_linux/v2/snap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,19 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Representations of the system's Snaps, and abstractions around managing them.
"""Legacy Charmhub-hosted snap library, deprecated in favour of ``charmlibs.snap``.

WARNING: This library is deprecated and will no longer receive feature updates or bugfixes.
``charmlibs.snap`` version 1.0 is a bug-for-bug compatible migration of this library.
Add 'charmlibs-snap~=1.0' to your charm's dependencies, and remove this Charmhub-hosted library.
Then replace `from charms.operator_libs_linux.v2 import snap` with `from charmlibs import snap`.
Read more:
- https://documentation.ubuntu.com/charmlibs
- https://pypi.org/project/charmlibs-snap

---

Representations of the system's Snaps, and abstractions around managing them.

The `snap` module provides convenience methods for listing, installing, refreshing, and removing
Snap packages, in addition to setting and getting configuration options for them.
Expand Down Expand Up @@ -109,7 +121,7 @@

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

PYDEPS = ["opentelemetry-api"]

Expand Down
Loading