charmlibs-snap 1.0.0__tar.gz

charmlibs_snap-1.0.0/.gitignore

@@ -0,0 +1,183 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.coverage-*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+.report/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc
+
+# packed charms
+.packed
+
+# temporary directory for packing charms
+.tmp
+
+# uv.lock from example libraries as we don't commit these
+.example/**/uv.lock
+interfaces/.example/**/uv.lock

charmlibs_snap-1.0.0/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.4
+Name: charmlibs-snap
+Version: 1.0.0
+Summary: The charmlibs.snap package.
+Project-URL: Documentation, https://documentation.ubuntu.com/charmlibs
+Project-URL: Repository, https://github.com/canonical/charmlibs
+Project-URL: Issues, https://github.com/canonical/charmlibs/issues
+Project-URL: Changelog, https://github.com/canonical/charmlibs/blob/main/snap/CHANGELOG.md
+Author: The Charm Tech team at Canonical
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: opentelemetry-api
+Description-Content-Type: text/markdown
+
+# charmlibs-snap
+
+The `snap` library.
+
+To install, add `charmlibs-snap` to your Python dependencies. Then in your Python code, import as:
+
+```py
+from charmlibs import snap
+```
+
+See the [reference documentation](https://documentation.ubuntu.com/charmlibs/reference/charmlibs/snap) for more.

charmlibs_snap-1.0.0/README.md

@@ -0,0 +1,11 @@
+# charmlibs-snap
+
+The `snap` library.
+
+To install, add `charmlibs-snap` to your Python dependencies. Then in your Python code, import as:
+
+```py
+from charmlibs import snap
+```
+
+See the [reference documentation](https://documentation.ubuntu.com/charmlibs/reference/charmlibs/snap) for more.

charmlibs_snap-1.0.0/pyproject.toml

@@ -0,0 +1,57 @@
+[project]
+name = "charmlibs-snap"
+description = "The charmlibs.snap package."
+readme = "README.md"
+requires-python = ">=3.10"
+authors = [
+    {name="The Charm Tech team at Canonical"},
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: Apache Software License",
+    "Intended Audience :: Developers",
+    "Operating System :: POSIX :: Linux",
+    "Development Status :: 5 - Production/Stable",
+]
+dynamic = ["version"]
+dependencies = [
+    "opentelemetry-api",
+]
+
+[dependency-groups]
+lint = [  # installed for `just lint snap` (unit, functional, and integration are also installed)
+    "typing_extensions",
+]
+unit = []
+functional = []
+integration = []
+
+[project.urls]
+"Documentation" = "https://documentation.ubuntu.com/charmlibs"
+"Repository" = "https://github.com/canonical/charmlibs"
+"Issues" = "https://github.com/canonical/charmlibs/issues"
+"Changelog" = "https://github.com/canonical/charmlibs/blob/main/snap/CHANGELOG.md"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/charmlibs"]
+
+[tool.hatch.version]
+path = "src/charmlibs/snap/_version.py"
+
+[tool.ruff]
+extend = "../pyproject.toml"
+src = ["src", "tests/unit", "tests/functional", "tests/integration"]  # correctly sort local imports in tests
+
+[tool.pyright]
+extends = "../pyproject.toml"
+include = ["src", "tests"]
+pythonVersion = "3.10"  # check no python > 3.10 features are used
+
+[tool.charmlibs.functional]
+ubuntu = ["22.04", "24.04"]  # ubuntu versions to run functional tests with, e.g. "24.04" (defaults to just "latest")
+pebble = []  # pebble versions to run functional tests with, e.g. "v1.0.0", "master" (defaults to no pebble versions)
+sudo = true  # whether to run functional tests with sudo (defaults to false)

charmlibs_snap-1.0.0/src/charmlibs/snap/__init__.py

@@ -0,0 +1,98 @@
+# Copyright 2025 Canonical Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# 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.
+
+The ``snap`` package provides convenience methods for listing, installing, refreshing, and removing
+Snap packages, in addition to setting and getting configuration options for them.
+
+In the ``snap`` package, ``SnapCache`` creates a ``dict``-like mapping of ``Snap`` objects when
+instantiated. Installed snaps are fully populated, and available snaps are lazily-loaded upon
+request. This module relies on an installed and running ``snapd`` daemon to perform operations over
+the ``snapd`` HTTP API.
+
+``SnapCache`` objects can be used to install or modify nnap packages by name in a manner similar to
+using the ``snap`` command from the commandline.
+
+An example of adding Juju to the system with ``SnapCache`` and setting a config value::
+
+    try:
+        cache = snap.SnapCache()
+        juju = cache["juju"]
+
+        if not juju.present:
+            juju.ensure(snap.SnapState.Latest, channel="beta")
+            juju.set({"some.key": "value", "some.key2": "value2"})
+    except snap.SnapError as e:
+        logger.error("An exception occurred when installing charmcraft. Reason: %s", e.message)
+
+In addition, the ``snap`` module provides "bare" methods which can act on Snap packages as
+simple function calls. :meth:`add`, :meth:`remove`, and :meth:`ensure` are provided, as
+well as :meth:`add_local` for installing directly from a local ``.snap`` file. These return
+``Snap`` objects.
+
+As an example of installing several Snaps and checking details::
+
+    try:
+        nextcloud, charmcraft = snap.add(["nextcloud", "charmcraft"])
+        if nextcloud.get("mode") != "production":
+            nextcloud.set({"mode": "production"})
+    except snap.SnapError as e:
+        logger.error("An exception occurred when installing snaps. Reason: %s" % e.message)
+"""
+
+from ._snap import (
+    Error,
+    JSONAble,
+    JSONType,
+    MetaCache,
+    Snap,
+    SnapAPIError,
+    SnapCache,
+    SnapClient,
+    SnapError,
+    SnapNotFoundError,
+    SnapService,
+    SnapServiceDict,
+    SnapState,
+    add,
+    ansi_filter,
+    ensure,
+    hold_refresh,
+    install_local,
+    remove,
+)
+from ._version import __version__ as __version__
+
+__all__ = [
+    'Error',
+    'JSONAble',
+    'JSONType',
+    'MetaCache',
+    'Snap',
+    'SnapAPIError',
+    'SnapCache',
+    'SnapClient',
+    'SnapError',
+    'SnapNotFoundError',
+    'SnapService',
+    'SnapServiceDict',
+    'SnapState',
+    'add',
+    'ansi_filter',
+    'ensure',
+    'hold_refresh',
+    'install_local',
+    'remove',
+]