red-tidegear 1.0.0__tar.gz

red_tidegear-1.0.0/.gitignore

@@ -0,0 +1,7 @@
+.data/
+.direnv/
+.venv/
+dist/
+.ruff_cache/
+**/__pycache__/
+**/version.py

red_tidegear-1.0.0/LICENSE.md

@@ -0,0 +1,207 @@
+# Mozilla Public License Version 2.0 (MPL-2.0)
+
+(Copied from [Mozilla Public License Version 2.0](https://www.mozilla.org/MPL/2.0/) and converted to markdown on 2023-01-06 (see: [licenses.markdown](https://codeberg.org/yelosan/licenses.markdown)).)
+
+---
+
+## 1. Definitions
+
+### 1.1. "Contributor"
+
+means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software.
+
+### 1.2. "Contributor Version"
+
+means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor's Contribution.
+
+### 1.3. "Contribution"
+
+means Covered Software of a particular Contributor.
+
+### 1.4. "Covered Software"
+
+means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof.
+
+### 1.5. "Incompatible With Secondary Licenses"
+
+means
+
+  a. that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or
+
+  b. that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License.
+
+### 1.6. "Executable Form"
+
+means any form of the work other than Source Code Form.
+
+### 1.7. "Larger Work"
+
+means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software.
+
+### 1.8. "License"
+
+means this document.
+
+### 1.9. "Licensable"
+
+means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License.
+
+### 1.10. "Modifications"
+
+means any of the following:
+
+  a. any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or
+
+  b. any new file in Source Code Form that contains any Covered Software.
+
+### 1.11. "Patent Claims" of a Contributor
+
+means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version.
+
+### 1.12. "Secondary License"
+
+means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses.
+
+### 1.13. "Source Code Form"
+
+means the form of the work preferred for making modifications.
+
+### 1.14. "You" (or "Your")
+
+means an individual or a legal entity exercising rights under this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, "control" means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity.
+
+## 2. License Grants and Conditions
+
+### 2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license:
+
+  a. under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and
+
+  b. under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version.
+
+### 2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution.
+
+### 2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor:
+
+  a. for any code that a Contributor has removed from Covered Software; or
+
+  b. for infringements caused by: (i) Your and any other third party's modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or
+
+  c. under Patent Claims infringed by Covered Software in the absence of its Contributions.
+
+This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4).
+
+### 2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3).
+
+### 2.5. Representation
+
+Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License.
+
+### 2.6. Fair Use
+
+This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents.
+
+### 2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1.
+
+## 3. Responsibilities
+
+### 3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients' rights in the Source Code Form.
+
+### 3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+  a. such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and
+
+  b. You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients' rights in the Source Code Form under this License.
+
+### 3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s).
+
+### 3.4. Notices
+
+You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies.
+
+### 3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction.
+
+## 4. Inability to Comply Due to Statute or Regulation
+
+If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it.
+
+## 5. Termination
+
+### 5.1
+
+The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice.
+
+### 5.2
+
+If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate.
+
+### 5.3
+
+In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination.
+
+## 6. Disclaimer of Warranty
+
+> Covered Software is provided under this License on an "as is" basis, without warranty of any kind, either expressed, implied, or statutory, including, without limitation, warranties that the Covered Software is free of defects, merchantable, fit for a particular purpose or non-infringing. The entire risk as to the quality and performance of the Covered Software is with You. Should any Covered Software prove defective in any respect, You (not any Contributor) assume the cost of any necessary servicing, repair, or correction. This disclaimer of warranty constitutes an essential part of this License. No use of any Covered Software is authorized under this License except under this disclaimer.
+
+## 7. Limitation of Liability
+
+> Under no circumstances and under no legal theory, whether tort (including negligence), contract, or otherwise, shall any Contributor, or anyone who distributes Covered Software as permitted above, be liable to You for any direct, indirect, special, incidental, or consequential damages of any character including, without limitation, damages for lost profits, loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if such party shall have been informed of the possibility of such damages. This limitation of liability shall not apply to liability for death or personal injury resulting from such party's negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You.
+
+## 8. Litigation
+
+Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party's ability to bring cross-claims or counter-claims.
+
+## 9. Miscellaneous
+
+This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor.
+
+## 10. Versions of the License
+
+### 10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number.
+
+### 10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward.
+
+### 10.3. Modified Versions
+
+If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License).
+
+### 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached.
+
+## Exhibit A - Source Code Form License Notice
+
+> This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at <https://mozilla.org/MPL/2.0/>.
+
+If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+## Exhibit B - "Incompatible With Secondary Licenses" Notice
+
+> This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
+
+---
+
+(Copied from [Mozilla Public License Version 2.0](https://www.mozilla.org/MPL/2.0/) and converted to markdown on 2023-01-06 (see: [licenses.markdown](https://codeberg.org/yelosan/licenses.markdown)).)

red_tidegear-1.0.0/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: red-tidegear
+Version: 1.0.0
+Project-URL: Homepage, https://c.csw.im/cswimr/tidegear
+Project-URL: Issues, https://c.csw.im/cswimr/tidegear/issues
+Project-URL: source_archive, https://c.csw.im/cswimr/tidegear/archive/7755d63a9a2e99222c342c1cc0b41456ac819bd3.tar.gz
+License-Expression: MPL-2.0
+License-File: LICENSE.md
+Requires-Python: <3.12,>=3.9
+Requires-Dist: furl>=2.1.4
+Requires-Dist: pip
+Requires-Dist: red-discordbot>=3.5.6
+Provides-Extra: pydantic
+Requires-Dist: pydantic>=2.11.0; extra == 'pydantic'
+Description-Content-Type: text/markdown
+
+# Tidegear
+
+[![Discord](https://img.shields.io/discord/1070058354925383681?logo=discord&color=%235661f6)](https://discord.gg/eMUMe77Yb8)
+![Python Versions](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fc.csw.im%2Fcswimr%2FCogUtils%2Fraw%2Fbranch%2Fmain%2Fpyproject.toml&logo=python)
+
+A collection of utilities for use with [Red-DiscordBot](https://github.com/Cog-Creators/Red-DiscordBot), made for [SeaCogs](https://c.csw.im/cswimr/SeaCogs).
+
+## Metadata File
+
+The cog class provided by [`tidegear.Cog`](./tidegear/cog.py) requires consuming cogs to have a `meta.json` file in your cog's bundled data directory. The `meta.json` file must match the schema provided in [`schema/meta/meta.json`](./schema/meta/meta.json). An example file is located at [`scheme/meta/meta.example.json`](./schema/meta/meta.example.json). Additional keys are disallowed by the schema but will not cause errors.
+
+## Developing
+
+You'll need some prerequisites before you can start working on CogUtils.  
+[git](https://git-scm.com) - [uv](https://docs.astral.sh/uv)  
+Additionally, I recommend a code editor of some variety. [Visual Studio Code](https://code.visualstudio.com) is a good, beginner-friendly option.
+
+### Installing Prerequisites
+
+_This section of the guide only applies to Windows systems.
+If you're on Linux, refer to the documentation of the projects listed above. I also offer a [Nix Flake](./flake.nix) that contains all of the required prerequisites, if you're a Nix user._
+
+#### [`git`](https://git-scm.com)
+
+You can download git from the [git download page](https://git-scm.com/downloads/win).
+
+Alternatively, you can use `winget`:
+
+```ps1
+winget install --id=Git.Git -e --source=winget
+```
+
+#### [`uv`](https://docs.astral.sh/uv)
+
+You can install uv with the following Powershell command:
+
+```ps1
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+Alternatively, you can use `winget`:
+
+```ps1
+winget install --id=astral-sh.uv -e
+```
+
+### Getting the Source Code
+
+Once you have [`git`](https://git-scm.com) installed, you can use the `git clone` command to get a copy of the repository on your system.
+
+```bash
+git clone https://c.csw.im/cswimr/tidegear.git
+```
+
+Then, you can use `uv` to install the Python dependencies required for development.
+
+```bash
+uv sync --all-groups --all-extras --frozen
+```

red_tidegear-1.0.0/README.md

@@ -0,0 +1,59 @@
+# Tidegear
+
+[![Discord](https://img.shields.io/discord/1070058354925383681?logo=discord&color=%235661f6)](https://discord.gg/eMUMe77Yb8)
+![Python Versions](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fc.csw.im%2Fcswimr%2FCogUtils%2Fraw%2Fbranch%2Fmain%2Fpyproject.toml&logo=python)
+
+A collection of utilities for use with [Red-DiscordBot](https://github.com/Cog-Creators/Red-DiscordBot), made for [SeaCogs](https://c.csw.im/cswimr/SeaCogs).
+
+## Metadata File
+
+The cog class provided by [`tidegear.Cog`](./tidegear/cog.py) requires consuming cogs to have a `meta.json` file in your cog's bundled data directory. The `meta.json` file must match the schema provided in [`schema/meta/meta.json`](./schema/meta/meta.json). An example file is located at [`scheme/meta/meta.example.json`](./schema/meta/meta.example.json). Additional keys are disallowed by the schema but will not cause errors.
+
+## Developing
+
+You'll need some prerequisites before you can start working on CogUtils.  
+[git](https://git-scm.com) - [uv](https://docs.astral.sh/uv)  
+Additionally, I recommend a code editor of some variety. [Visual Studio Code](https://code.visualstudio.com) is a good, beginner-friendly option.
+
+### Installing Prerequisites
+
+_This section of the guide only applies to Windows systems.
+If you're on Linux, refer to the documentation of the projects listed above. I also offer a [Nix Flake](./flake.nix) that contains all of the required prerequisites, if you're a Nix user._
+
+#### [`git`](https://git-scm.com)
+
+You can download git from the [git download page](https://git-scm.com/downloads/win).
+
+Alternatively, you can use `winget`:
+
+```ps1
+winget install --id=Git.Git -e --source=winget
+```
+
+#### [`uv`](https://docs.astral.sh/uv)
+
+You can install uv with the following Powershell command:
+
+```ps1
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+Alternatively, you can use `winget`:
+
+```ps1
+winget install --id=astral-sh.uv -e
+```
+
+### Getting the Source Code
+
+Once you have [`git`](https://git-scm.com) installed, you can use the `git clone` command to get a copy of the repository on your system.
+
+```bash
+git clone https://c.csw.im/cswimr/tidegear.git
+```
+
+Then, you can use `uv` to install the Python dependencies required for development.
+
+```bash
+uv sync --all-groups --all-extras --frozen
+```

red_tidegear-1.0.0/pyproject.toml

@@ -0,0 +1,115 @@
+[project]
+name = "red-tidegear"
+requires-python = ">=3.9,<3.12"
+readme = "README.md"
+license = "MPL-2.0"
+license-files = ["LICEN[CS]E*"]
+dependencies = [
+  "pip",                   # Red-DiscordBot depends on pip but doesn't list it as a dependency. Ensure it's installed; version is irrelevant.
+  "furl>=2.1.4",
+  "red-discordbot>=3.5.6",
+]
+dynamic = ["version", "urls"]
+
+[project.optional-dependencies]
+pydantic = ["pydantic>=2.11.0"]
+
+[dependency-groups]
+dev = ["basedpyright>=1.29.4", "ruff>=0.12.0"]
+
+[tool.hatch.build]
+include = ["/tidegear"]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "tidegear/version.py"
+template = """
+# This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+# If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# © 2025 cswimr
+
+# This file is automatically generated on build, do not edit!
+# Do not commit this file to source control!
+
+from furl import furl
+
+from .metadata import Repository, SemVer, TidegearMeta
+
+meta = TidegearMeta(
+    version=SemVer(*{version_tuple}),
+    repository=Repository(
+        owner="cswimr",
+        name="tidegear",
+        url=furl("https://c.csw.im/cswimr/tidegear"),
+    ),
+)
+
+version = meta.version
+__version__ = str(meta.version)
+"""
+
+[tool.hatch.metadata.hooks.vcs.urls]
+Homepage = "https://c.csw.im/cswimr/tidegear"
+Issues = "https://c.csw.im/cswimr/tidegear/issues"
+source_archive = "https://c.csw.im/cswimr/tidegear/archive/{commit_hash}.tar.gz"
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.basedpyright]
+typeCheckingMode = "standard"
+reportImplicitOverride = "warning"
+
+[tool.ruff]
+line-length = 150
+indent-width = 4
+target-version = "py39"
+
+[tool.ruff.lint]
+select = [
+  "I",
+  "N",
+  "F",
+  "W",
+  "E",
+  "G",
+  "A",
+  "COM",
+  "INP",
+  "T20",
+  "PLC",
+  "PLE",
+  "PLW",
+  "PLR",
+  "LOG",
+  "SLF",
+  "ERA",
+  "FIX",
+  "PERF",
+  "C4",
+  "EM",
+  "RET",
+  "RSE",
+]
+ignore = [
+  "PLR0911",
+  "PLR0912",
+  "PLR0915",
+  "PLR2004",
+  "PLR0913",
+  "EM101",
+  "COM812",
+]
+fixable = ["ALL"]
+unfixable = []
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+docstring-code-format = true
+docstring-code-line-length = "dynamic"

red_tidegear-1.0.0/tidegear/__init__.py

@@ -0,0 +1,8 @@
+# This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+# If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# © 2025 cswimr
+from .cog import Cog
+from .metadata import CogMetadata
+from .version import __version__, meta, version
+
+__all__ = ["__version__", "Cog", "CogMetadata", "meta", "version"]

red_tidegear-1.0.0/tidegear/cog.py

@@ -0,0 +1,79 @@
+# This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+# If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# © 2025 cswimr
+
+from typing import List
+
+from discord import Guild, User
+from red_commons.logging import RedTraceLogger, getLogger
+from redbot.core import commands, data_manager
+from redbot.core.bot import Red
+from redbot.core.utils.chat_formatting import bold, humanize_list
+from typing_extensions import override
+
+from .metadata import CogMetadata
+from .version import meta
+
+
+class Cog(commands.Cog):
+    def __init__(self, bot: Red) -> None:
+        super().__init__()
+        self.bot: Red = bot
+        # this is fine because Red itself will fail if the client isn't logged in way before this cog would be loaded
+        self.me: User = bot.get_user(bot.user.id)  # pyright: ignore[reportAttributeAccessIssue, reportOptionalMemberAccess]
+        path = data_manager.bundled_data_path(self) / "meta.json"
+        if not path.exists():
+            msg = f"There is no metadata file located at {path}!"
+            raise FileNotFoundError(msg)
+        self.metadata: CogMetadata = CogMetadata.from_json(self.__cog_name__, path)
+        self.logger: RedTraceLogger = getLogger(f"red.{self.metadata.repository.name}.{self.__cog_name__}")
+
+    @override
+    def format_help_for_context(self, ctx: commands.Context) -> str:
+        base = (super().format_help_for_context(ctx) or "").rstrip("\n") + "\n"
+        parts: List[str] = [base]
+        parts.append(f"{bold('Cog Version:')} [{self.metadata.version}]({self.metadata.repository.url})")
+        author_label = "Authors:" if len(self.metadata.authors) >= 2 else "Author:"
+        parts.append(f"{bold(author_label)} {humanize_list([author.markdown for author in self.metadata.authors])}")
+        if self.metadata.documentation is not None:
+            parts.append(f"{bold('Documentation:')} {self.metadata.documentation}")
+        parts.append(f"{bold('Tidegear Version:')} {meta.markdown}")
+        return "\n".join(parts)
+
+    async def get_or_fetch_user(self, user_id: int) -> User:
+        """Retrieve a user from the internal cache, or fetch it if it cannot be found.
+        Use this sparingly, as the `fetch_user` endpoint has a strict ratelimit.
+
+        Args:
+            user_id (int): The ID of the user to retrieve.
+
+        Raises:
+            discord.NotFound: If the user does not exist.
+            discord.HTTPException: Fetching the user failed.
+
+        Returns:
+            User: The retrieved user.
+        """
+        user = self.bot.get_user(user_id)
+        if not user:
+            user = await self.bot.fetch_user(user_id)
+        return user
+
+    async def get_or_fetch_guild(self, guild_id: int) -> Guild:
+        """Retrieve a guild from the internal cache, or fetch it if it cannot be found.
+        Use this sparingly, as the `fetch_guild` endpoint has a strict ratelimit.
+
+        Args:
+            guild_id (int): The ID of the guild to retrieve.
+
+        Raises:
+            discord.NotFound: If the guild does not exist or the bot does not have access to it.
+            discord.HTTPException: Fetching the guild failed.
+
+        Returns:
+            Guild: The retrieved guild.
+        """
+        guild = self.bot.get_guild(guild_id)
+        if not guild:
+            guild = await self.bot.fetch_guild(guild_id)
+        return guild

red_tidegear-1.0.0/tidegear/metadata.py

@@ -0,0 +1,124 @@
+# This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+# If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# © 2025 cswimr
+
+import re
+from dataclasses import dataclass
+from pathlib import Path
+from typing import List, Optional
+
+import orjson
+from furl import furl
+from typing_extensions import override
+
+
+@dataclass
+class SemVer:
+    major: int
+    minor: int
+    patch: int
+    extra: Optional[str] = None
+    commit: Optional[str] = None
+
+    @override
+    def __str__(self) -> str:
+        string = f"{self.major}.{self.minor}.{self.patch}"
+        if self.extra:
+            string += self.extra
+        if self.commit:
+            string += f"+{self.commit}"
+        return string
+
+    @classmethod
+    def from_str(cls, version: str, /) -> "SemVer":
+        """
+        Parse a version string of the form `MAJOR.MINOR.PATCH[EXTRA]`, where `EXTRA` is any string (often things like '-alpha.1' or '+build.123').
+        """
+        pattern = r"^(\d+)\.(\d+)\.(\d+)([-+].+)?$"
+        m = re.match(pattern, version)
+        if not m:
+            msg = f"Invalid SemVer string: {version!r}"
+            raise ValueError(msg)
+        major, minor, patch, extra = m.groups()
+        return cls(int(major), int(minor), int(patch), extra)
+
+
+@dataclass
+class User:
+    name: str
+    profile: furl
+
+    @override
+    def __str__(self) -> str:
+        return self.name
+
+    @property
+    def markdown(self) -> str:
+        return f"[{self.name}]({self.profile})"
+
+
+@dataclass
+class Repository:
+    owner: str
+    name: str
+    url: furl
+
+    @override
+    def __str__(self) -> str:
+        return self.name
+
+    @property
+    def slug(self) -> str:
+        return self.name.lower()
+
+    @property
+    def issues(self) -> furl:
+        return self.url / "issues"
+
+    @property
+    def markdown(self) -> str:
+        return f"[{self.owner}/{self.name}]({self.url})"
+
+
+@dataclass
+class CogMetadata:
+    name: str
+    version: SemVer
+    authors: List[User]
+    repository: Repository
+    documentation: Optional[furl] = None
+
+    @classmethod
+    def from_json(cls, cog_name: str, file: Path) -> "CogMetadata":
+        """Load cog metadata from a JSON file.
+
+        Args:
+            cog_name (str): The name of the cog.
+            file (Path): The file path of the JSON file to load from.
+
+        Returns:
+            CogMetadata: The constructed metadata object.
+        """
+        with open(file, "rb") as f:
+            obj = orjson.loads(f.read())
+
+        authors = [User(name=author["name"], profile=furl(author["url"])) for author in obj["authors"]]
+        repository = Repository(owner=obj["repository"]["owner"], name=obj["repository"]["name"], url=furl(obj["repository"]["url"]))
+        if (documentation := obj.get("documentation", None)) is not None:
+            documentation = furl(documentation)
+        version = SemVer.from_str(obj["version"])
+        return cls(name=cog_name, version=version, authors=authors, repository=repository, documentation=documentation)
+
+
+@dataclass
+class TidegearMeta:
+    version: SemVer
+    repository: Repository
+
+    @override
+    def __str__(self) -> str:
+        return str(self.version)
+
+    @property
+    def markdown(self) -> str:
+        return f"[{self.version}]({self.repository.url})"

red_tidegear-1.0.0/tidegear/pydantic/__init__.py

@@ -0,0 +1,15 @@
+# This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+# If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# © 2025 cswimr
+
+from importlib.util import find_spec
+
+if not find_spec("pydantic"):
+    raise ImportError(
+        "pydantic is not installed, but the `cogutils.pydantic` module was imported! Did you install cogutils with the `pydantic` extra?"
+    )
+
+from .basemodel import BaseModel, CogModel
+from .httpurl import HttpUrl
+
+__all__ = ["BaseModel", "CogModel", "HttpUrl"]

red_tidegear-1.0.0/tidegear/pydantic/basemodel.py

@@ -0,0 +1,299 @@
+# This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+# If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# © 2025 cswimr
+
+from typing import Any, Callable, Dict, List, Literal, Optional, TypeVar, Union, overload
+
+import orjson
+from discord import Colour, Embed
+from pydantic import BaseModel as PydanticBaseModel
+from pydantic import ConfigDict, Field, ValidationError
+from pydantic.main import IncEx
+from pydantic_core import ErrorDetails
+from red_commons.logging import RedTraceLogger
+from redbot.core import commands
+from redbot.core.utils.chat_formatting import bold, error, inline
+from redbot.core.utils.views import _ACCEPTABLE_PAGE_TYPES, SimpleMenu
+from typing_extensions import Self, override
+
+from ..cog import Cog
+from ..metadata import CogMetadata
+
+R = TypeVar("R")
+
+
+class BaseModel(PydanticBaseModel):
+    model_config = ConfigDict(validate_assignment=True, arbitrary_types_allowed=True)
+
+    @overload
+    @classmethod
+    def validate_field(cls, field_name: str, field_value: Any, converter: Callable[[Any], R]) -> R: ...
+
+    @overload
+    @classmethod
+    def validate_field(cls, field_name: str, field_value: Any, converter: None = None) -> Any: ...
+
+    @classmethod
+    def validate_field(cls, field_name: str, field_value: Any, converter: Optional[Callable[[Any], R]] = None) -> Union[R, Any]:
+        """Wraps internal Pydantic methods to allow validating a single field without running validation for an entire model.
+
+        Args:
+            field_name (str): The name of the field to validate your input against.
+            field_value (Any): The input value to validate.
+            converter (Callable[[Any], R] | None): A function to use to convert the resulting value.
+
+        Returns:
+            R | Any: The validated input value.
+        """
+        model: Self = cls.__pydantic_validator__.validate_assignment(cls.model_construct(), field_name, field_value)  # pyright: ignore[reportAssignmentType]
+        attribute = getattr(model, field_name)
+        if converter:
+            return converter(attribute)
+        return attribute
+
+    @overload
+    def json(
+        self,
+        /,
+        *,
+        include: IncEx = ...,
+        exclude: IncEx = ...,
+        remove_token: bool = ...,
+        string: Literal[False] = False,
+        encoding: str = ...,
+        indent: bool = ...,
+    ) -> Dict[str, Any]: ...
+
+    @overload
+    def json(
+        self,
+        /,
+        *,
+        include: IncEx = ...,
+        exclude: IncEx = ...,
+        remove_token: bool = ...,
+        string: Literal[True],
+        encoding: str = ...,
+        indent: bool = ...,
+    ) -> str: ...
+
+    @override
+    def json(  # pyright: ignore[reportIncompatibleMethodOverride]
+        self,
+        /,
+        *,
+        include: IncEx = set(),
+        exclude: IncEx = set(),
+        remove_token: bool = True,
+        string: bool = False,
+        encoding: str = "utf-8",
+        indent: bool = False,
+    ) -> Union[Dict[str, Any], str]:
+        """Dumps the contents of the model to a JSON-serializable dictionary.
+
+        Set an attribute's default value to `Field(exclude=True)` to exclude it from this function's output automatically.
+
+        Args:
+            include (pydantic.IncEx): A set of fields to include in the model dump.
+            exclude (pydantic.IncEx): A set of fields to exclude from the model dump.
+            remove_token (bool): Whether or not to recursively remove keys named `token` from the output object.
+            string (bool): Whether or not to use `orjson.dumps()` to convert the resulting dictionary to a string.
+            encoding (str): The encoding to use to decode the bytes returned by `orjson.dumps()`.
+            indent (bool): Whether or not to pretty-print the output. This is slower and should only be used when an end user is seeing the output.
+
+        Returns:
+            `dict[str, Any]`: A Dictionary containing only JSON-serializable attributes, if `string` is `False`.
+            `str`: A string representation of the Dictionary mentioned previously, converted using `orjson.dumps()`.
+        """
+        params = {"exclude": exclude, "mode": "json"}
+        if include:
+            params["include"] = include
+
+        obj = self.model_dump(**params)
+
+        if remove_token:
+            obj = self._recurse_modify(obj, "token", lambda token: "*" * 6 if token else None)
+
+        if string:
+            opts: Optional[int] = None
+            if indent:
+                opts = orjson.OPT_INDENT_2
+            return orjson.dumps(obj, option=opts).decode(encoding)
+
+        return obj
+
+    def _recurse_modify(self, obj: Any, key: str, modify_fn: Callable[..., Any]) -> Any:
+        """
+        Returns a deep-copied version of obj where every dict-key matching `key` has its value replaced by modify_fn(old_value).
+        """
+        if isinstance(obj, dict):
+            new_dict = {}
+            for k, v in obj.items():
+                if k == key:
+                    new_dict[k] = modify_fn(v)
+                else:
+                    new_dict[k] = self._recurse_modify(v, key, modify_fn)
+            return new_dict
+        if isinstance(obj, list):
+            return [self._recurse_modify(item, key, modify_fn) for item in obj]
+        if isinstance(obj, tuple):
+            return tuple(self._recurse_modify(item, key, modify_fn) for item in obj)
+        if isinstance(obj, set):
+            return {self._recurse_modify(item, key, modify_fn) for item in obj}
+        return obj
+
+    @staticmethod
+    def _custom_validation_messages() -> Dict[str, Union[str, Dict[str, str]]]:
+        return {
+            "string_pattern_mismatch": {
+                r"^[\w\-]+$": "String may only contain letters, numbers, underscores, and hyphens.",
+            },
+        }
+
+    @classmethod
+    def _replace_error_messages(cls, validation_error: ValidationError, /) -> List[ErrorDetails]:
+        """Replace a few error messages with more human-readable variants.
+
+        Args:
+            err (ValidationError): The Pydantic ValidationError to convert the messages of.
+
+        Returns:
+            list[ErrorDetails]: The converted messages.
+        """
+
+        new_errors: List[ErrorDetails] = []
+        for err in validation_error.errors():
+            err_type = err.get("type")
+            custom_message = cls._custom_validation_messages().get(err_type)
+
+            if err_type == "string_pattern_mismatch":
+                if not isinstance(custom_message, dict):
+                    msg = f"Invalid type for {err_type}!"
+                    raise TypeError(msg)
+
+                if not (ctx := err.get("ctx")) or not (pattern := ctx.get("pattern")):
+                    raise ValueError("Error details do not contain a regex pattern!")
+
+                for k, v in custom_message.items():
+                    if pattern == k:
+                        err["msg"] = v.format(**ctx)
+
+            elif isinstance(custom_message, str):
+                ctx = err.get("ctx")
+                err["msg"] = custom_message.format(**ctx) if ctx else custom_message
+
+            new_errors.append(err)
+        return new_errors
+
+    @classmethod
+    async def validation_error_menu(
+        cls,
+        err: ValidationError,
+        ctx: Optional[commands.Context] = None,
+        *,
+        class_name: Optional[str] = None,
+        metadata: Optional[CogMetadata] = None,
+        logger: Optional[RedTraceLogger] = None,
+        title: str = "🚫 Validation Error",
+        color: Union[Colour, int] = Colour.red(),
+        per_page: int = 5,
+    ) -> Optional[SimpleMenu]:
+        """
+        Take a Pydantic ValidationError, split its .errors() into pages, and create a SimpleMenu from them.
+
+        Args:
+            err (ValidationError): The ValidationError to create an error embed from.
+            ctx (Commands.Context, optional): The context to use to provide additional help when the error occurred within a command.
+            class_name (str, optional): The name of the class to show in the resulting embed's description.
+            This only needs to be provided if the class you're validating against doesn't inherit from `BaseModel`.
+            metadata (CogMetaData, optional): Cog metadata to use to populate the resulting embed.
+            logger (RedTraceLogger, optional): A logger to log the exception to.
+            title (str, optional): The title of the created embeds. Defaults to `🚫 Validation Error`.
+            color (discord.Colour | int, optional): The color of the created embeds. Defaults to `discord.Colour.red()`.
+            per_page (int, optional): How many validation errors to list per page. Defaults to `5`.
+
+        Returns:
+            SimpleMenu: The created SimpleMenu, which you can then start with `await SimpleMenu.start(ctx)`.
+            None: If `ctx` is provided and the bot cannot post embeds in the context channel,
+            or if the `ValidationError` exception doesn't provide any errors.
+
+        Example Usage (Red `[p]eval`):
+        ```python
+        from typing import Annotated
+        from pydantic import StringConstraints, ValidationError
+        from .cogutils.pydantic import BaseModel
+
+
+        class ExampleModel(BaseModel):
+            string: Annotated[str, StringConstraints(min_length=3)]
+
+
+        try:
+            ExampleModel(string="hi")
+        except ValidationError as err:  # String should have at least 3 characters (string_too_short)
+            if menu := await ExampleModel.validation_error_menu(err, ctx):
+                await menu.start(ctx)
+        ```
+        """
+        lines: List[Optional[str]] = [
+            f"Validation error encountered for the {inline(class_name or err.title)} class!",
+            (f"Please check {inline(f'{ctx.clean_prefix}help {ctx.command.qualified_name}')} to ensure you are passing the correct arguments.")
+            if (ctx and ctx.command)
+            else None,
+            f"If this is unexpected or you're having trouble working around this error, please report it [here]({metadata.repository.issues})."
+            if metadata
+            else None,
+        ]
+        description = "\n".join(line for line in lines if line is not None)
+
+        if logger:
+            logger.exception(lines[0], exc_info=err)
+
+        if ctx:
+            if not await ctx.embed_requested():
+                await ctx.send(
+                    f"{error('Tried to post an issue embed, but I cannot post embeds in this channel or embeds are disabled!')}\n\n{description}"
+                )
+                return None
+
+        problems = cls._replace_error_messages(err)
+        total = len(problems)
+        if total == 0:
+            return None
+
+        footer_text = ""
+
+        if tb := err.__traceback__:
+            module = tb.tb_frame.f_globals.get("__name__", "unknown")
+            line = tb.tb_lineno
+            function = tb.tb_frame.f_code.co_name
+            footer_text = f"• Exception in module '{module}' in function '{function}' at line #{line}\n"
+
+        pages: List[_ACCEPTABLE_PAGE_TYPES] = []
+        total_pages = (total - 1) // per_page + 1
+
+        for i in range(0, total, per_page):
+            embed = Embed(title=title, color=color, description=description)
+            embed.set_footer(text=footer_text + f"• Page {i // per_page + 1}/{total_pages}")
+
+            for problem in problems[i : i + per_page]:
+                loc = ".".join(str(x) for x in problem["loc"])
+                msg: str = problem.get("msg", "").replace("'", "`")
+                input_value = problem.get("input", "UNKNOWN")
+
+                if code := problem.get("type", ""):
+                    if code_url := problem.get("url"):
+                        code = f"[{inline(code)}]({code_url})"
+                else:
+                    code = "UNKNOWN"
+
+                field_value = f"{bold('Message:')} {msg}\n{bold('Input: ')} {inline(input_value)}\n{bold('Code:')} {code}"
+                embed.add_field(name=f"Field: {inline(loc or 'base')}", value=field_value, inline=False)
+
+            pages.append(embed)
+
+        return SimpleMenu(pages)
+
+
+class CogModel(BaseModel):
+    cog: Cog = Field(exclude=True)

red_tidegear-1.0.0/tidegear/pydantic/httpurl.py

@@ -0,0 +1,83 @@
+# This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+# If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# © 2025 cswimr
+
+from typing import Optional
+
+from discord.utils import MISSING
+from pydantic import HttpUrl as PydanticHttpUrl
+from typing_extensions import Self
+
+
+class HttpUrl(PydanticHttpUrl):
+    """
+    A subclass of `pydantic.HttpUrl` that adds some useful methods and operator overloads for more ergonomic path manipulation and URL composition.
+
+    Operations:
+      - `url / "segment"`  - returns a new HttpUrl with "segment" appended to the path
+      - `url /= "segment"` - in-place append of "segment" to the path
+
+    Examples:
+        >>> u = HttpUrl("https://example.com/api")
+        >>> u2 = u / "v1" / "users"
+        >>> print(u2)
+        https://example.com/api/v1/users
+
+        >>> u2 /= "123"
+        >>> print(u2)
+        https://example.com/api/v1/users/123
+    """
+
+    def __truediv__(self, other: str) -> Self:
+        return self.join(other)
+
+    def __itruediv__(self, other: str) -> Self:
+        return self.__truediv__(other)
+
+    @property
+    def base(self) -> Self:
+        """Wrapper around `HttpUrl.join()` that returns the base URL (scheme, host, etc.).
+
+        Returns:
+            Self: The new HttpUrl object pointing to the base URL of the source HttpUrl object.
+        """
+        return self.join(None, query=None, fragment=None)
+
+    def join(self, path: Optional[str] = MISSING, /, *, query: Optional[str] = MISSING, fragment: Optional[str] = MISSING) -> Self:
+        """Create a new HttpUrl object using `HttpUrl.build()`.
+
+        Args:
+            path (str): The path to add to this HttpUrl's path.
+                Defaults to MISSING, will replace the original path if set to `None`.
+            query (str | None): The query to replace this HttpUrl's query with.
+                Defaults to MISSING, will replace the original query if set to `None`.
+            fragment (str | None): The fragment to replace this HttpUrl's fragment with.
+                Defaults to MISSING, will replace the original fragment if set to `None`.
+
+        Returns:
+            Self: The new HttpUrl object.
+        """
+
+        def _strip(s: str, /) -> str:
+            return s.lstrip("/").rstrip("/")
+
+        base = _strip(self.path or "")
+
+        if path is MISSING:
+            new_path = base
+        elif path is None:
+            new_path = ""
+        else:
+            seg = _strip(path)
+            new_path = f"{base}/{seg}" if base else seg
+
+        return self.build(
+            scheme=self.scheme,
+            username=self.username,
+            password=self.password,
+            host=self.host or "",
+            port=self.port,
+            path=new_path,
+            query=self.query if query is MISSING else query,
+            fragment=self.fragment if fragment is MISSING else fragment,
+        )

red_tidegear-1.0.0/tidegear/version.py

@@ -0,0 +1,22 @@
+# This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+# If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# © 2025 cswimr
+
+# This file is automatically generated on build, do not edit!
+# Do not commit this file to source control!
+
+from furl import furl
+
+from .metadata import Repository, SemVer, TidegearMeta
+
+meta = TidegearMeta(
+    version=SemVer(*(1, 0, 0)),
+    repository=Repository(
+        owner="cswimr",
+        name="tidegear",
+        url=furl("https://c.csw.im/cswimr/tidegear"),
+    ),
+)
+
+version = meta.version
+__version__ = str(meta.version)