botgauge-cli 0.1.0__tar.gz → 0.1.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,78 @@
1
+ Metadata-Version: 2.4
2
+ Name: botgauge-cli
3
+ Version: 0.1.2
4
+ Summary: The botgauge command-line tool: one entry point for every installed BotGauge component.
5
+ Author-email: "BotGauge AI Inc." <support@botgauge.com>
6
+ License-Expression: FSL-1.1-ALv2
7
+ Project-URL: Homepage, https://www.botgauge.com/
8
+ Keywords: botgauge,cli
9
+ Classifier: Development Status :: 4 - Beta
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: Environment :: Console
12
+ Classifier: Programming Language :: Python :: 3 :: Only
13
+ Classifier: Programming Language :: Python :: 3.10
14
+ Classifier: Programming Language :: Python :: 3.11
15
+ Classifier: Programming Language :: Python :: 3.12
16
+ Classifier: Programming Language :: Python :: 3.13
17
+ Classifier: Programming Language :: Python :: 3.14
18
+ Requires-Python: >=3.10
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Dynamic: license-file
22
+
23
+ <p align="center">
24
+ <a href="https://www.botgauge.com/"><img src="https://www.botgauge.com/og_images/web-app-manifest-512x512.png" alt="BotGauge" width="80"></a>
25
+ </p>
26
+
27
+ <h1 align="center">botgauge-cli</h1>
28
+
29
+ <p align="center">
30
+ The <code>botgauge</code> command: one entry point for every installed BotGauge component.
31
+ </p>
32
+
33
+ <p align="center">
34
+ <a href="https://pypi.org/project/botgauge-cli/"><img src="https://img.shields.io/pypi/v/botgauge-cli?style=flat-square&label=pypi%20botgauge-cli" alt="PyPI version"></a>
35
+ <a href="https://pypi.org/project/botgauge-cli/"><img src="https://img.shields.io/pypi/pyversions/botgauge-cli?style=flat-square" alt="Python versions"></a>
36
+ <img src="https://img.shields.io/badge/dependencies-standard%20library%20only-success?style=flat-square" alt="Standard library only">
37
+ <img src="https://img.shields.io/badge/license-FSL--1.1--ALv2-blue?style=flat-square" alt="License: FSL-1.1-ALv2">
38
+ </p>
39
+
40
+ `botgauge-cli` owns the `botgauge` console script (and its short alias, `botg`) and hands each command
41
+ to the installed BotGauge component that provides it. It is a building block: install
42
+ [`botgauge`](https://pypi.org/project/botgauge/), which brings this command together with the tracing
43
+ SDK that provides its commands.
44
+
45
+ ## Install
46
+
47
+ ```bash
48
+ pip install botgauge # the tracing SDK and this command
49
+ botgauge setup --install # adds tracing for the frameworks your app uses
50
+ ```
51
+
52
+ On its own, `botgauge-cli` only runs `botgauge help` and `botgauge version`; the other commands come
53
+ from `botgauge-tracing`, and `botgauge help` says how to install whatever is missing.
54
+
55
+ ## Commands
56
+
57
+ | Command | What it does | Provided by |
58
+ |---|---|---|
59
+ | `botgauge help` | Lists every installed command, and which package provides the ones that are missing | `botgauge-cli` |
60
+ | `botgauge version` | Shows the installed BotGauge versions | `botgauge-cli` |
61
+ | `botgauge instrument python app.py` | Traces an existing app without changing its code | [`botgauge-tracing`](https://pypi.org/project/botgauge-tracing/) |
62
+ | `botgauge doctor` | Read-only check of the tracing setup in the current process | `botgauge-tracing` |
63
+ | `botgauge setup --detect` | Recommends the framework extras to install, without installing anything | `botgauge-tracing` |
64
+ | `botgauge probe --endpoint URL` | Sends one diagnostic span and confirms the endpoint accepted it | `botgauge-tracing` |
65
+
66
+ `botg` works everywhere `botgauge` does: `botg instrument python app.py`.
67
+
68
+ ## How it works
69
+
70
+ Components register commands in the `botgauge.commands` entry-point group. Top-level names are
71
+ reserved per package (`src/botgauge/cli/_names.py`), so one package can never take over another's
72
+ command. It uses the standard library only, and every BotGauge component depends on it.
73
+
74
+ ## Links
75
+
76
+ - Website: [botgauge.com](https://www.botgauge.com/)
77
+ - Console and API keys: [cloud.botgauge.com](https://cloud.botgauge.com)
78
+ - Support: [support@botgauge.com](mailto:support@botgauge.com)
@@ -0,0 +1,56 @@
1
+ <p align="center">
2
+ <a href="https://www.botgauge.com/"><img src="https://www.botgauge.com/og_images/web-app-manifest-512x512.png" alt="BotGauge" width="80"></a>
3
+ </p>
4
+
5
+ <h1 align="center">botgauge-cli</h1>
6
+
7
+ <p align="center">
8
+ The <code>botgauge</code> command: one entry point for every installed BotGauge component.
9
+ </p>
10
+
11
+ <p align="center">
12
+ <a href="https://pypi.org/project/botgauge-cli/"><img src="https://img.shields.io/pypi/v/botgauge-cli?style=flat-square&label=pypi%20botgauge-cli" alt="PyPI version"></a>
13
+ <a href="https://pypi.org/project/botgauge-cli/"><img src="https://img.shields.io/pypi/pyversions/botgauge-cli?style=flat-square" alt="Python versions"></a>
14
+ <img src="https://img.shields.io/badge/dependencies-standard%20library%20only-success?style=flat-square" alt="Standard library only">
15
+ <img src="https://img.shields.io/badge/license-FSL--1.1--ALv2-blue?style=flat-square" alt="License: FSL-1.1-ALv2">
16
+ </p>
17
+
18
+ `botgauge-cli` owns the `botgauge` console script (and its short alias, `botg`) and hands each command
19
+ to the installed BotGauge component that provides it. It is a building block: install
20
+ [`botgauge`](https://pypi.org/project/botgauge/), which brings this command together with the tracing
21
+ SDK that provides its commands.
22
+
23
+ ## Install
24
+
25
+ ```bash
26
+ pip install botgauge # the tracing SDK and this command
27
+ botgauge setup --install # adds tracing for the frameworks your app uses
28
+ ```
29
+
30
+ On its own, `botgauge-cli` only runs `botgauge help` and `botgauge version`; the other commands come
31
+ from `botgauge-tracing`, and `botgauge help` says how to install whatever is missing.
32
+
33
+ ## Commands
34
+
35
+ | Command | What it does | Provided by |
36
+ |---|---|---|
37
+ | `botgauge help` | Lists every installed command, and which package provides the ones that are missing | `botgauge-cli` |
38
+ | `botgauge version` | Shows the installed BotGauge versions | `botgauge-cli` |
39
+ | `botgauge instrument python app.py` | Traces an existing app without changing its code | [`botgauge-tracing`](https://pypi.org/project/botgauge-tracing/) |
40
+ | `botgauge doctor` | Read-only check of the tracing setup in the current process | `botgauge-tracing` |
41
+ | `botgauge setup --detect` | Recommends the framework extras to install, without installing anything | `botgauge-tracing` |
42
+ | `botgauge probe --endpoint URL` | Sends one diagnostic span and confirms the endpoint accepted it | `botgauge-tracing` |
43
+
44
+ `botg` works everywhere `botgauge` does: `botg instrument python app.py`.
45
+
46
+ ## How it works
47
+
48
+ Components register commands in the `botgauge.commands` entry-point group. Top-level names are
49
+ reserved per package (`src/botgauge/cli/_names.py`), so one package can never take over another's
50
+ command. It uses the standard library only, and every BotGauge component depends on it.
51
+
52
+ ## Links
53
+
54
+ - Website: [botgauge.com](https://www.botgauge.com/)
55
+ - Console and API keys: [cloud.botgauge.com](https://cloud.botgauge.com)
56
+ - Support: [support@botgauge.com](mailto:support@botgauge.com)
@@ -7,8 +7,8 @@ build-backend = "setuptools.build_meta"
7
7
  # component depends on this, so it must never pull anything in. Installs `botgauge/cli/` under the
8
8
  # PEP 420 `botgauge` namespace and never ships `botgauge/__init__.py`.
9
9
  name = "botgauge-cli"
10
- version = "0.1.0"
11
- description = "The `botgauge` command: one entry point that dispatches to every installed BotGauge component."
10
+ version = "0.1.2"
11
+ description = "The botgauge command-line tool: one entry point for every installed BotGauge component."
12
12
  readme = "README.md"
13
13
  requires-python = ">=3.10"
14
14
  license = "FSL-1.1-ALv2"
@@ -41,6 +41,11 @@ RESERVED: dict[str, str] = {
41
41
  PUBLISHED = frozenset({"botgauge", "botgauge-cli", "botgauge-tracing"})
42
42
 
43
43
 
44
+ #: Components the ``botgauge`` meta-package installs. Their commands point to ``pip install botgauge``,
45
+ #: the install every BotGauge guide shows, rather than to the component's own distribution.
46
+ INSTALLED_BY_BOTGAUGE = frozenset({"botgauge-tracing"})
47
+
48
+
44
49
  def install_hint(owner: str) -> str:
45
50
  """Return how to install ``owner``'s commands.
46
51
 
@@ -48,9 +53,11 @@ def install_hint(owner: str) -> str:
48
53
  owner: A distribution name.
49
54
 
50
55
  Returns:
51
- ``"pip install <owner>"`` for a published distribution, otherwise a note that this release
52
- does not publish it.
56
+ ``"pip install botgauge"`` for a component the meta-package installs, ``"pip install <owner>"``
57
+ for another published distribution, otherwise a note that this release does not publish it.
53
58
  """
59
+ if owner in INSTALLED_BY_BOTGAUGE:
60
+ return "pip install botgauge"
54
61
  return f"pip install {owner}" if owner in PUBLISHED else "not published in this release"
55
62
 
56
63
 
@@ -0,0 +1,78 @@
1
+ Metadata-Version: 2.4
2
+ Name: botgauge-cli
3
+ Version: 0.1.2
4
+ Summary: The botgauge command-line tool: one entry point for every installed BotGauge component.
5
+ Author-email: "BotGauge AI Inc." <support@botgauge.com>
6
+ License-Expression: FSL-1.1-ALv2
7
+ Project-URL: Homepage, https://www.botgauge.com/
8
+ Keywords: botgauge,cli
9
+ Classifier: Development Status :: 4 - Beta
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: Environment :: Console
12
+ Classifier: Programming Language :: Python :: 3 :: Only
13
+ Classifier: Programming Language :: Python :: 3.10
14
+ Classifier: Programming Language :: Python :: 3.11
15
+ Classifier: Programming Language :: Python :: 3.12
16
+ Classifier: Programming Language :: Python :: 3.13
17
+ Classifier: Programming Language :: Python :: 3.14
18
+ Requires-Python: >=3.10
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Dynamic: license-file
22
+
23
+ <p align="center">
24
+ <a href="https://www.botgauge.com/"><img src="https://www.botgauge.com/og_images/web-app-manifest-512x512.png" alt="BotGauge" width="80"></a>
25
+ </p>
26
+
27
+ <h1 align="center">botgauge-cli</h1>
28
+
29
+ <p align="center">
30
+ The <code>botgauge</code> command: one entry point for every installed BotGauge component.
31
+ </p>
32
+
33
+ <p align="center">
34
+ <a href="https://pypi.org/project/botgauge-cli/"><img src="https://img.shields.io/pypi/v/botgauge-cli?style=flat-square&label=pypi%20botgauge-cli" alt="PyPI version"></a>
35
+ <a href="https://pypi.org/project/botgauge-cli/"><img src="https://img.shields.io/pypi/pyversions/botgauge-cli?style=flat-square" alt="Python versions"></a>
36
+ <img src="https://img.shields.io/badge/dependencies-standard%20library%20only-success?style=flat-square" alt="Standard library only">
37
+ <img src="https://img.shields.io/badge/license-FSL--1.1--ALv2-blue?style=flat-square" alt="License: FSL-1.1-ALv2">
38
+ </p>
39
+
40
+ `botgauge-cli` owns the `botgauge` console script (and its short alias, `botg`) and hands each command
41
+ to the installed BotGauge component that provides it. It is a building block: install
42
+ [`botgauge`](https://pypi.org/project/botgauge/), which brings this command together with the tracing
43
+ SDK that provides its commands.
44
+
45
+ ## Install
46
+
47
+ ```bash
48
+ pip install botgauge # the tracing SDK and this command
49
+ botgauge setup --install # adds tracing for the frameworks your app uses
50
+ ```
51
+
52
+ On its own, `botgauge-cli` only runs `botgauge help` and `botgauge version`; the other commands come
53
+ from `botgauge-tracing`, and `botgauge help` says how to install whatever is missing.
54
+
55
+ ## Commands
56
+
57
+ | Command | What it does | Provided by |
58
+ |---|---|---|
59
+ | `botgauge help` | Lists every installed command, and which package provides the ones that are missing | `botgauge-cli` |
60
+ | `botgauge version` | Shows the installed BotGauge versions | `botgauge-cli` |
61
+ | `botgauge instrument python app.py` | Traces an existing app without changing its code | [`botgauge-tracing`](https://pypi.org/project/botgauge-tracing/) |
62
+ | `botgauge doctor` | Read-only check of the tracing setup in the current process | `botgauge-tracing` |
63
+ | `botgauge setup --detect` | Recommends the framework extras to install, without installing anything | `botgauge-tracing` |
64
+ | `botgauge probe --endpoint URL` | Sends one diagnostic span and confirms the endpoint accepted it | `botgauge-tracing` |
65
+
66
+ `botg` works everywhere `botgauge` does: `botg instrument python app.py`.
67
+
68
+ ## How it works
69
+
70
+ Components register commands in the `botgauge.commands` entry-point group. Top-level names are
71
+ reserved per package (`src/botgauge/cli/_names.py`), so one package can never take over another's
72
+ command. It uses the standard library only, and every BotGauge component depends on it.
73
+
74
+ ## Links
75
+
76
+ - Website: [botgauge.com](https://www.botgauge.com/)
77
+ - Console and API keys: [cloud.botgauge.com](https://cloud.botgauge.com)
78
+ - Support: [support@botgauge.com](mailto:support@botgauge.com)
@@ -1,38 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: botgauge-cli
3
- Version: 0.1.0
4
- Summary: The `botgauge` command: one entry point that dispatches to every installed BotGauge component.
5
- Author-email: "BotGauge AI Inc." <support@botgauge.com>
6
- License-Expression: FSL-1.1-ALv2
7
- Project-URL: Homepage, https://www.botgauge.com/
8
- Keywords: botgauge,cli
9
- Classifier: Development Status :: 4 - Beta
10
- Classifier: Intended Audience :: Developers
11
- Classifier: Environment :: Console
12
- Classifier: Programming Language :: Python :: 3 :: Only
13
- Classifier: Programming Language :: Python :: 3.10
14
- Classifier: Programming Language :: Python :: 3.11
15
- Classifier: Programming Language :: Python :: 3.12
16
- Classifier: Programming Language :: Python :: 3.13
17
- Classifier: Programming Language :: Python :: 3.14
18
- Requires-Python: >=3.10
19
- Description-Content-Type: text/markdown
20
- License-File: LICENSE
21
- Dynamic: license-file
22
-
23
- # botgauge-cli
24
-
25
- The `botgauge` command. It owns the `botgauge` console script (plus a short alias, `botg`) and
26
- dispatches each command to the installed BotGauge component that provides it:
27
-
28
- ```bash
29
- botgauge help # every installed command, and which package provides the rest
30
- botgauge version # installed BotGauge versions
31
- botgauge instrument python app.py # provided by botgauge-tracing
32
- botgauge doctor # provided by botgauge-tracing
33
- ```
34
-
35
- Components register commands in the `botgauge.commands` entry-point group. Top-level names are
36
- reserved per package (`src/botgauge/cli/_names.py`), so one package can never take over another's
37
- command. Standard library only; every BotGauge component depends on it. You normally get it through
38
- `pip install botgauge` rather than installing it directly.
@@ -1,16 +0,0 @@
1
- # botgauge-cli
2
-
3
- The `botgauge` command. It owns the `botgauge` console script (plus a short alias, `botg`) and
4
- dispatches each command to the installed BotGauge component that provides it:
5
-
6
- ```bash
7
- botgauge help # every installed command, and which package provides the rest
8
- botgauge version # installed BotGauge versions
9
- botgauge instrument python app.py # provided by botgauge-tracing
10
- botgauge doctor # provided by botgauge-tracing
11
- ```
12
-
13
- Components register commands in the `botgauge.commands` entry-point group. Top-level names are
14
- reserved per package (`src/botgauge/cli/_names.py`), so one package can never take over another's
15
- command. Standard library only; every BotGauge component depends on it. You normally get it through
16
- `pip install botgauge` rather than installing it directly.
@@ -1,38 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: botgauge-cli
3
- Version: 0.1.0
4
- Summary: The `botgauge` command: one entry point that dispatches to every installed BotGauge component.
5
- Author-email: "BotGauge AI Inc." <support@botgauge.com>
6
- License-Expression: FSL-1.1-ALv2
7
- Project-URL: Homepage, https://www.botgauge.com/
8
- Keywords: botgauge,cli
9
- Classifier: Development Status :: 4 - Beta
10
- Classifier: Intended Audience :: Developers
11
- Classifier: Environment :: Console
12
- Classifier: Programming Language :: Python :: 3 :: Only
13
- Classifier: Programming Language :: Python :: 3.10
14
- Classifier: Programming Language :: Python :: 3.11
15
- Classifier: Programming Language :: Python :: 3.12
16
- Classifier: Programming Language :: Python :: 3.13
17
- Classifier: Programming Language :: Python :: 3.14
18
- Requires-Python: >=3.10
19
- Description-Content-Type: text/markdown
20
- License-File: LICENSE
21
- Dynamic: license-file
22
-
23
- # botgauge-cli
24
-
25
- The `botgauge` command. It owns the `botgauge` console script (plus a short alias, `botg`) and
26
- dispatches each command to the installed BotGauge component that provides it:
27
-
28
- ```bash
29
- botgauge help # every installed command, and which package provides the rest
30
- botgauge version # installed BotGauge versions
31
- botgauge instrument python app.py # provided by botgauge-tracing
32
- botgauge doctor # provided by botgauge-tracing
33
- ```
34
-
35
- Components register commands in the `botgauge.commands` entry-point group. Top-level names are
36
- reserved per package (`src/botgauge/cli/_names.py`), so one package can never take over another's
37
- command. Standard library only; every BotGauge component depends on it. You normally get it through
38
- `pip install botgauge` rather than installing it directly.
File without changes
File without changes
File without changes