weblate_schemas 2024.1__tar.gz

weblate_schemas-2024.1/CHANGES.rst

@@ -0,0 +1,90 @@
+Changelog
+=========
+
+2024.1
+------
+
+* Released on 9th April 2024.
+* Dropped support for Python 3.7 and 3.8.
+* Added support for Python 3.12.
+* Clarified address field on user data.
+
+2023.3
+------
+
+* Released on 8th June 2023.
+* Added theme to user data.
+
+2023.2
+------
+
+* Released on 2nd March 2023.
+* Fixed project backup with unicode website URLs.
+
+2023.1
+------
+
+* Released on 5th February 2023.
+* Fixed testsuite failure.
+* Added support for Python 3.11 and 3.10.
+* Dropped support for Python 3.6.
+* Fixed project backups schema to allow blank project website.
+
+2022.1
+------
+
+* Released on 17th August 2022.
+* Added validate_schema API.
+* Added caching to schema loading.
+* Added timestamp validation.
+* Switched to CalVer versioning.
+* Added schema for component backups.
+
+0.8
+---
+
+* Released on 25th July 2022.
+* Added schema for project backups.
+
+0.7
+---
+
+* Released on 17th Match 2021.
+* Fixed minor syntax issue in user data schema.
+
+0.6
+---
+
+* Released on 5th Match 2021.
+* Improved examples.
+* Fixed license information.
+
+0.5
+---
+
+* Released on 8th Decemeber 2020.
+* Fixed validation of translation memory entries with newlines.
+
+0.4
+---
+
+* Released on 5th August 2020.
+* Added schema for user downloadable data.
+
+0.3
+---
+
+* Released on 10th March 2020.
+* Switch to more standard naming of schema files (.schema.json).
+
+0.2
+---
+
+* Released on 10th March 2020.
+* Fixed language code validation.
+
+0.1
+---
+
+* Released on 10th March 2020.
+* Initial release.

weblate_schemas-2024.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2012–2023 Michal Čihař
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

weblate_schemas-2024.1/MANIFEST.in

@@ -0,0 +1,9 @@
+include LICENSE
+include ChangeLog
+include README.rst
+include CHANGES.rst
+include requirements-test.txt
+include requirements.txt
+include weblate_schemas/*.py
+recursive-include weblate_schemas/schemas *
+global-exclude *.swp *.swo

weblate_schemas-2024.1/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.1
+Name: weblate_schemas
+Version: 2024.1
+Summary: A collection of JSON schemas used by Weblate
+Home-page: https://weblate.org/
+Download-URL: https://github.com/WeblateOrg/weblate_schemas
+Author: Michal Čihař
+Author-email: michal@cihar.com
+License: MIT
+Project-URL: Issue Tracker, https://github.com/WeblateOrg/weblate_schemas/issues
+Project-URL: Documentation, https://docs.weblate.org/
+Project-URL: Source Code, https://github.com/WeblateOrg/weblate_schemas
+Project-URL: Twitter, https://twitter.com/WeblateOrg
+Project-URL: Funding, https://weblate.org/donate/
+Keywords: i18n l10n gettext translate weblate
+Platform: any
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Internationalization
+Classifier: Topic :: Software Development :: Localization
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+
+.. image:: https://s.weblate.org/cdn/Logo-Darktext-borders.png
+   :alt: Weblate
+   :target: https://weblate.org/
+   :height: 80px
+
+**Weblate is libre software web-based continuous localization system,
+used by over 2500 libre projects and companies in more than 165 countries.**
+
+This module contains schemas used in Weblate exports.
+
+.. image:: https://img.shields.io/badge/website-weblate.org-blue.svg
+    :alt: Website
+    :target: https://weblate.org/
+
+.. image:: https://hosted.weblate.org/widgets/weblate/-/svg-badge.svg
+    :alt: Translation status
+    :target: https://hosted.weblate.org/engage/weblate/?utm_source=widget
+
+.. image:: https://bestpractices.coreinfrastructure.org/projects/552/badge
+    :alt: CII Best Practices
+    :target: https://bestpractices.coreinfrastructure.org/projects/552
+
+.. image:: https://img.shields.io/pypi/v/weblate_schemas.svg
+    :target: https://pypi.org/project/weblate_schemas/
+    :alt: PyPI package
+
+.. image:: https://img.shields.io/readthedocs/weblate.svg
+    :alt: Documentation
+    :target: https://docs.weblate.org/en/latest/schemas.html
+
+Installation
+------------
+
+Install using pip:
+
+.. code-block:: sh
+
+    pip3 install weblate_schemas
+
+Sources are available at <https://github.com/WeblateOrg/weblate_schemas>.
+
+Contributing
+------------
+
+Contributions are welcome! See `documentation <https://docs.weblate.org/en/latest/contributing/modules.html>`__ for more information.

weblate_schemas-2024.1/README.rst

@@ -0,0 +1,45 @@
+.. image:: https://s.weblate.org/cdn/Logo-Darktext-borders.png
+   :alt: Weblate
+   :target: https://weblate.org/
+   :height: 80px
+
+**Weblate is libre software web-based continuous localization system,
+used by over 2500 libre projects and companies in more than 165 countries.**
+
+This module contains schemas used in Weblate exports.
+
+.. image:: https://img.shields.io/badge/website-weblate.org-blue.svg
+    :alt: Website
+    :target: https://weblate.org/
+
+.. image:: https://hosted.weblate.org/widgets/weblate/-/svg-badge.svg
+    :alt: Translation status
+    :target: https://hosted.weblate.org/engage/weblate/?utm_source=widget
+
+.. image:: https://bestpractices.coreinfrastructure.org/projects/552/badge
+    :alt: CII Best Practices
+    :target: https://bestpractices.coreinfrastructure.org/projects/552
+
+.. image:: https://img.shields.io/pypi/v/weblate_schemas.svg
+    :target: https://pypi.org/project/weblate_schemas/
+    :alt: PyPI package
+
+.. image:: https://img.shields.io/readthedocs/weblate.svg
+    :alt: Documentation
+    :target: https://docs.weblate.org/en/latest/schemas.html
+
+Installation
+------------
+
+Install using pip:
+
+.. code-block:: sh
+
+    pip3 install weblate_schemas
+
+Sources are available at <https://github.com/WeblateOrg/weblate_schemas>.
+
+Contributing
+------------
+
+Contributions are welcome! See `documentation <https://docs.weblate.org/en/latest/contributing/modules.html>`__ for more information.

weblate_schemas-2024.1/pyproject.toml

@@ -0,0 +1,50 @@
+[tool.black]
+target-version = ['py39']
+
+[tool.isort]
+profile = "black"
+
+[tool.ruff]
+ignore = [
+  "D203",  # CONFIG: incompatible with D211
+  "D212"  # CONFIG: incompatible with D213
+]
+output-format = "github"
+select = [
+  "E",
+  "F",
+  "B",
+  "T10",
+  "A",
+  "C4",
+  "C90",
+  "YTT",
+  "DJ",
+  "UP",
+  "D",
+  "PD",
+  "PGH",
+  "PL",
+  "TRY",
+  "RUF",
+  "ERA",
+  "ICN",
+  "ISC",
+  "EXE",
+  "INP",
+  "PIE",
+  "G",
+  "PYI",
+  "Q",
+  "SIM",
+  "TID",
+  "RSE",
+  "T20",
+  "RET",
+  "SLF",
+  "N"
+]
+target-version = "py39"
+
+[tool.ruff.mccabe]
+max-complexity = 16

weblate_schemas-2024.1/requirements-test.txt

@@ -0,0 +1,4 @@
+-r requirements.txt
+pytest
+pytest-cov
+twine==5.0.0

weblate_schemas-2024.1/requirements.txt

@@ -0,0 +1,4 @@
+fqdn
+jsonschema
+rfc3987
+strict-rfc3339

weblate_schemas-2024.1/setup.cfg

@@ -0,0 +1,56 @@
+[metadata]
+name = weblate_schemas
+version = 2024.1
+description = A collection of JSON schemas used by Weblate
+long_description = file: README.rst
+long_description_content_type = text/x-rst
+url = https://weblate.org/
+author = Michal Čihař
+author_email = michal@cihar.com
+license = MIT
+license_file = LICENSE
+platforms = any
+classifiers = 
+	Development Status :: 5 - Production/Stable
+	Intended Audience :: Developers
+	License :: OSI Approved :: MIT License
+	Operating System :: OS Independent
+	Programming Language :: Python
+	Programming Language :: Python :: 3
+	Programming Language :: Python :: 3 :: Only
+	Topic :: Software Development :: Internationalization
+	Topic :: Software Development :: Localization
+	Topic :: Utilities
+download_url = https://github.com/WeblateOrg/weblate_schemas
+keywords = i18n l10n gettext translate weblate
+project_urls = 
+	Issue Tracker=https://github.com/WeblateOrg/weblate_schemas/issues
+	Documentation=https://docs.weblate.org/
+	Source Code=https://github.com/WeblateOrg/weblate_schemas
+	Twitter=https://twitter.com/WeblateOrg
+	Funding=https://weblate.org/donate/
+
+[options]
+packages = find_namespace:
+python_requires = >=3.9
+include_package_data = 1
+zip_safe = 0
+
+[flake8]
+max-complexity = 16
+extend-select = E,W1,W2,W3,W504,W505,W6,B
+enable-extensions = B,C,D,DJ,F,G,I,M,N,R,SF,UPS
+extend-ignore = E203
+exclude = 
+max-line-length = 88
+per-file-ignores = 
+
+[pycodestyle]
+extend-select = E,W1,W2,W3,W504,W505,W6
+exclude = 
+max-line-length = 88
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

weblate_schemas-2024.1/setup.py

@@ -0,0 +1,14 @@
+#!/usr/bin/env python
+
+# Copyright © Michal Čihař <michal@weblate.org>
+#
+# SPDX-License-Identifier: MIT
+
+"""Setup file for easy installation."""
+
+from setuptools import setup
+
+with open("requirements.txt") as handle:
+    REQUIRES = list(handle.read().splitlines())
+
+setup(install_requires=REQUIRES)

weblate_schemas-2024.1/weblate_schemas/__init__.py

@@ -0,0 +1,33 @@
+# Copyright © Michal Čihař <michal@weblate.org>
+#
+# SPDX-License-Identifier: MIT
+
+"""Schemas used by Weblate."""
+
+import json
+from pathlib import Path
+
+from jsonschema import FormatChecker, validate
+
+SCHEMA_BASE = Path(__file__).resolve().parent.joinpath("schemas")
+
+SCHEMA_CACHE = {}
+
+
+def get_path(name: str):
+    """Build filename for a schema."""
+    return SCHEMA_BASE.joinpath(name)
+
+
+def load_schema(name: str):
+    """Load schema from a disk."""
+    if name not in SCHEMA_CACHE:
+        with get_path(name).open("r") as handle:
+            SCHEMA_CACHE[name] = json.load(handle)
+    return SCHEMA_CACHE[name]
+
+
+def validate_schema(data: dict, name: str):
+    """Validate data to match schema."""
+    schema = load_schema(name)
+    validate(data, schema, format_checker=FormatChecker())

weblate_schemas-2024.1/weblate_schemas/schemas/weblate-backup.schema.json

@@ -0,0 +1,245 @@
+{
+  "$id": "https://weblate.org/schemas/weblate-backup.schema.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "definitions": {},
+  "title": "Weblate backup",
+  "additionalProperties": false,
+  "required": [
+    "metadata",
+    "project",
+    "labels"
+  ],
+  "properties": {
+    "metadata": {
+      "$id": "#root/metadata",
+      "title": "Export metadata",
+      "type": "object",
+      "required": [
+        "version",
+        "server",
+        "domain",
+        "timestamp"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "version": {
+          "$id": "#root/metadata/version",
+          "title": "Weblate version",
+          "type": "string",
+          "default": "",
+          "examples": [
+            "4.13"
+          ]
+        },
+        "server": {
+          "$id": "#root/metadata/server",
+          "title": "Server name",
+          "type": "string",
+          "default": "",
+          "examples": [
+            "Weblate"
+          ]
+        },
+        "domain": {
+          "$id": "#root/metadata/domain",
+          "title": "Server domain",
+          "type": "string",
+          "format": "hostname",
+          "default": "",
+          "examples": [
+            "weblate.example.com"
+          ]
+        },
+        "timestamp": {
+          "$id": "#root/metadata/timestamp",
+          "title": "Export timestamp",
+          "type": "string",
+          "format": "date-time",
+          "default": "",
+          "examples": [
+            "2019-11-18T18:53:54.862Z"
+          ]
+        }
+      }
+    },
+    "project": {
+      "$id": "#root/project",
+      "title": "Project",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "slug",
+        "web",
+        "instructions",
+        "access_control",
+        "language_aliases",
+        "set_language_team",
+        "use_shared_tm",
+        "contribute_shared_tm",
+        "translation_review",
+        "source_review",
+        "enable_hooks"
+      ],
+      "properties": {
+        "name": {
+          "$id": "#root/project/name",
+          "title": "Project name",
+          "type": "string",
+          "default": "",
+          "examples": [
+            "Hello"
+          ]
+        },
+        "slug": {
+          "$id": "#root/project/slug",
+          "title": "URL slug",
+          "type": "string",
+          "default": "",
+          "examples": [
+            "hello"
+          ]
+        },
+        "web": {
+          "$id": "#root/project/web",
+          "title": "",
+          "anyOf": [
+            {
+              "type": "string",
+              "format": "iri"
+            },
+            {
+              "type": "string",
+              "maxLength": 0
+            }
+          ],
+          "default": "Project website",
+          "examples": [
+            "https://weblate.org/"
+          ]
+        },
+        "instructions": {
+          "$id": "#root/project/instructions",
+          "title": "Translation instructions",
+          "type": "string",
+          "default": ""
+        },
+        "access_control": {
+          "$id": "#root/project/access_control",
+          "title": "Access control",
+          "type": "integer",
+          "enum": [
+            0,
+            1,
+            100,
+            200
+          ],
+          "default": 0,
+          "examples": [
+            0
+          ]
+        },
+        "language_aliases": {
+          "$id": "#root/project/language_aliases",
+          "title": "Language aliases",
+          "type": "string",
+          "default": "",
+          "examples": [
+            ""
+          ]
+        },
+        "set_language_team": {
+          "$id": "#root/project/set_language_team",
+          "title": "Set \"Language-Team\" header",
+          "type": "boolean",
+          "default": false
+        },
+        "use_shared_tm": {
+          "$id": "#root/project/use_shared_tm",
+          "title": "Use shared translation memory",
+          "type": "boolean",
+          "default": false
+        },
+        "contribute_shared_tm": {
+          "$id": "#root/project/contribute_shared_tm",
+          "title": "Contribute to shared translation memory",
+          "type": "boolean",
+          "default": false
+        },
+        "translation_review": {
+          "$id": "#root/project/translation_review",
+          "title": "Enable reviews",
+          "type": "boolean",
+          "default": false
+        },
+        "source_review": {
+          "$id": "#root/project/source_review",
+          "title": "Enable source reviews",
+          "type": "boolean",
+          "default": false
+        },
+        "enable_hooks": {
+          "$id": "#root/project/enable_hooks",
+          "title": "Enable hooks",
+          "type": "boolean",
+          "default": false
+        }
+      }
+    },
+    "labels": {
+      "$id": "#root/labels",
+      "title": "Project labels",
+      "type": "array",
+      "default": [],
+      "items": {
+        "$id": "#root/labels/items",
+        "title": "Items",
+        "type": "object",
+        "required": [
+          "name",
+          "color"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "name": {
+            "$id": "#root/auditlog/items/name",
+            "title": "Label name",
+            "type": "string",
+            "default": "",
+            "examples": [
+              "Label"
+            ]
+          },
+          "color": {
+            "$id": "#root/auditlog/items/color",
+            "title": "Color",
+            "type": "string",
+            "default": "",
+            "examples": [
+              "navy"
+            ],
+            "enum": [
+              "navy",
+              "blue",
+              "aqua",
+              "teal",
+              "olive",
+              "green",
+              "lime",
+              "yellow",
+              "orange",
+              "red",
+              "maroon",
+              "fuchsia",
+              "purple",
+              "black",
+              "gray",
+              "silver"
+            ]
+          }
+        }
+      }
+    }
+  }
+}