Skip to content

Commit 6e6995d

Browse files
sed-irbarry82
sed-i
and
rbarry82
authored
Pipify (#37)
* Copy juju_topology into a temp package * Add py.typed marker * Add py.typed marker * Lint * Add deprecation warning * Add quality checks tox envs * Add CosTool * Copy CosTool updates from grafana_dashboard * Add cos-tool tests (from prom's test_transform) * Re-export * Revert "Copy CosTool updates from grafana_dashboard" This reverts commit 809be79. * Cleanup * Rename to cosl * Pass a series since we're pinned * Pin pylibjuju to 3.0.* * Do not pass series * Revert "Do not pass series" This reverts commit b6dca31. * raise_on_error=False * Lint * Loosen dep requirements * Don't configure on every instantiation * Fix the signature for _configure --------- Co-authored-by: Ryan Barry <[email protected]>
1 parent 20c7e97 commit 6e6995d

File tree

20 files changed

+1221
-16
lines changed

20 files changed

+1221
-16
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
dist/
12
venv/
23
build/
34
*.charm

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
## Description
77

88
Observability Libs is a placeholder charm that is used to provide a home for [charm libraries] that
9-
are used for the development of charms deployed as part of the LMA Light [bundle].
9+
are used for the development of charms deployed as part of the COS Lite [bundle].
1010

1111
## Usage
1212

@@ -36,6 +36,6 @@ charm following best practice guidelines, and `CONTRIBUTING.md` for developer gu
3636

3737
[KubernetesServicePatch]: https://charmhub.io/observability-libs/libraries/kubernetes_service_patch
3838
[KubernetesComputeResourcesPatch]: https://charmhub.io/observability-libs/libraries/kubernetes_compute_resources_patch
39-
[bundle]: https://charmhub.io/lma-light
39+
[bundle]: https://charmhub.io/cos-lite
4040
[charm libraries]: https://juju.is/docs/sdk/libraries
4141
[JujuTopology]: https://charmhub.io/observability-libs/libraries/juju_topology

‎lib/charms/observability_libs/v0/juju_topology.py‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@
6767
```
6868
6969
"""
70+
import warnings
7071
from collections import OrderedDict
7172
from typing import Dict, List, Optional
7273
from uuid import UUID
@@ -75,7 +76,7 @@
7576
LIBID = "bced1658f20f49d28b88f61f83c2d232"
7677

7778
LIBAPI = 0
78-
LIBPATCH = 4
79+
LIBPATCH = 5
7980

8081

8182
class InvalidUUIDError(Exception):
@@ -87,7 +88,11 @@ def __init__(self, uuid: str):
8788

8889

8990
class JujuTopology:
90-
"""JujuTopology is used for storing, generating and formatting juju topology information."""
91+
"""JujuTopology is used for storing, generating and formatting juju topology information.
92+
93+
DEPRECATED: This class is deprecated. Use `pip install cosl` and
94+
`from cosl.juju_topology import JujuTopology` instead.
95+
"""
9196

9297
def __init__(
9398
self,
@@ -115,6 +120,11 @@ def __init__(
115120
unit: a unit name as a string
116121
charm_name: name of charm as a string
117122
"""
123+
warnings.warn(
124+
"observability_libs.v0.juju_topology is deprecated. Use `pip install cosl` instead",
125+
category=DeprecationWarning,
126+
)
127+
118128
if not self.is_valid_uuid(model_uuid):
119129
raise InvalidUUIDError(model_uuid)
120130

‎placeholder/LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎placeholder/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# cosl
2+
Utils for COS Lite charms.

‎placeholder/pyproject.toml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
[build-system]
2+
requires = ["hatchling"]
3+
build-backend = "hatchling.build"
4+
5+
[project]
6+
name = "cosl"
7+
version = "0.0.1"
8+
authors = [
9+
{ name="sed-i", email="[email protected]" },
10+
]
11+
description = "Utils for COS Lite charms"
12+
readme = "README.md"
13+
requires-python = ">=3.8"
14+
classifiers = [
15+
"Programming Language :: Python :: 3.8",
16+
"License :: OSI Approved :: Apache Software License",
17+
"Operating System :: OS Independent",
18+
"Topic :: Utilities",
19+
"Intended Audience :: Developers",
20+
"Intended Audience :: System Administrators",
21+
"Development Status :: 4 - Beta",
22+
"Typing :: Typed",
23+
]
24+
25+
[project.urls]
26+
"Homepage" = "https://github.com/canonical/observability-libs/"
27+
"Bug Tracker" = "https://github.com/canonical/observability-libs/issues"
28+
29+
[package]
30+
include = ["py.typed"]
31+
32+
# Testing tools configuration
33+
[tool.coverage.run]
34+
branch = true
35+
36+
[tool.coverage.report]
37+
show_missing = true
38+
39+
# Formatting tools configuration
40+
[tool.black]
41+
line-length = 99
42+
target-version = ["py38"]
43+
44+
[tool.isort]
45+
profile = "black"
46+
47+
# Linting tools configuration
48+
[tool.flake8]
49+
max-line-length = 99
50+
max-doc-length = 99
51+
max-complexity = 10
52+
exclude = [".git", "__pycache__", ".tox", "build", "dist", "*.egg_info", "venv"]
53+
select = ["E", "W", "F", "C", "N", "R", "D", "H"]
54+
# Ignore W503, E501 because using black creates errors with this
55+
# Ignore D107 Missing docstring in __init__
56+
ignore = ["W503", "E501", "D107"]
57+
# D100, D101, D102, D103: Ignore missing docstrings in tests
58+
per-file-ignores = ["tests/*:D100,D101,D102,D103"]
59+
docstring-convention = "google"
60+
# Check for properly formatted copyright header in each file
61+
copyright-check = "True"
62+
copyright-author = "Canonical Ltd."
63+
copyright-regexp = "Copyright\\s\\d{4}([-,]\\d{4})*\\s+%(author)s"
64+
65+
# Static analysis tools configuration
66+
[tool.mypy]
67+
pretty = true
68+
python_version = 3.8
69+
follow_imports = "normal"
70+
warn_redundant_casts = true
71+
warn_unused_ignores = true
72+
warn_unused_configs = true
73+
show_traceback = true
74+
show_error_codes = true
75+
namespace_packages = true
76+
explicit_package_bases = true
77+
check_untyped_defs = true
78+
allow_redefinition = true
79+
no_implicit_optional = false
80+

‎placeholder/requirements-dev.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ops

‎placeholder/src/cosl/__init__.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Copyright 2023 Canonical Ltd.
2+
# See LICENSE file for licensing details.
3+
4+
"""Utils for observability Juju charms."""
5+
6+
from .cos_tool import CosTool
7+
from .juju_topology import JujuTopology
8+
9+
__all__ = [JujuTopology, CosTool]

0 commit comments

Comments
 (0)