codegrade 17.0.48__tar.gz → 17.0.49__tar.gz

codegrade-17.0.49/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: codegrade
+Version: 17.0.49
+Summary: A client library for accessing CodeGrade
+Project-URL: Documentation, https://python.api.codegrade.com
+License-Expression: AGPL-3.0-only OR BSD-3-Clause-Clear
+Requires-Python: <4.0,>=3.12
+Requires-Dist: httpx<1.0.0,>=0.19.0
+Requires-Dist: python-dateutil<3,>=2.8.1
+Requires-Dist: structlog>=20.1.0
+Requires-Dist: typing-extensions<5,>=4.13.2
+Requires-Dist: validate-email~=1.3
+Description-Content-Type: text/markdown
+
+# CodeGrade API
+
+This library makes it easier to use the CodeGrade API. Its API allows you to
+automate your usage of CodeGrade. We are currently still busy documenting the
+entire API, but everything that is possible in the UI of CodeGrade is also
+possible through the API.
+## Installation
+You can install the library through [pypi](https://pypi.org/), simply run
+`python3 -m pip install codegrade`. If you want to get a dev version with support
+for the latest features, simply email [support@codegrade.com](mailto:support@codegrade.com)
+and we'll provide you with a dev version.
+## Usage
+First, create a client:
+
+```python
+import codegrade
+
+# Don't store your password in your code!
+with codegrade.login(
+    username='my-username',
+    password=os.getenv('CG_PASSWORD'),
+    tenant='My University',
+) as client:
+    pass
+
+# Or supply information interactively.
+with codegrade.login_from_cli() as client:
+    pass
+```
+
+Now call your endpoint and use your models:
+
+```python
+from codegrade.models import PatchCourseData
+
+courses = client.course.get_all()
+for course in courses:
+    client.course.patch(
+        PatchCourseData(name=course.name + ' (NEW)'),
+        course_id=course.id,
+    )
+
+# Or, simply use dictionaries.
+for course in courses:
+    client.course.patch(
+        {"name": course.name + ' (NEW)'},
+        course_id=course.id,
+    )
+```
+
+For the complete documentation go to
+https://python.api.codegrade.com.
+## Backwards compatibility
+CodeGrade is constantly upgrading its API, but we try to minimize backwards
+incompatible changes. We'll announce every backwards incompatible change in the
+[changelog](http://codegrade.com/changelog). A new version of the API
+client is released with every release of CodeGrade, which is approximately every
+month. To upgrade simply run `pip install --upgrade codegrade`.
+## Supported python versions
+We support python 3.6 and above, `pypy` is currently not tested but should work
+just fine.
+## License
+The library is licensed under AGPL-3.0-only or BSD-3-Clause-Clear.

codegrade-17.0.49/docs/conf.py

@@ -0,0 +1,136 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+import json
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+from datetime import date
+
+cur_dir = os.path.dirname(__file__)
+
+# -- Project information -----------------------------------------------------
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+project = "codegrade"
+copyright = str(date.today().year) + ", CodeGrade"
+author = "CodeGrade Team"
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = "17.0.49"
+# The full version, including alpha/beta/rc tags.
+release = version
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autosummary",
+    "sphinx_autodoc_typehints",
+    "myst_parser",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = [
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+    "",
+    "psef_api/psef.rst",
+    "build/*",
+    "readme/*",
+]
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "CodeGradedoc"
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "furo"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+html_css_files = ["custom_style.css"]
+html_js_files = ["toggle.js"]
+
+html_favicon = "_static/favicon/favicon.ico"
+html_logo = "_static/images/logo.svg"
+html_title = "CodeGrade 17.0.49"
+
+# -- Extension configuration -------------------------------------------------
+
+autodoc_default_options = {
+    "undoc-members": True,
+    "exclude-members": "__init__, __new__",
+}
+autoclass_content = "init"
+autodoc_class_signature = "separated"
+autodoc_member_order = "bysource"
+autodoc_typehints = "both"
+
+autosummary_generate = True
+
+add_module_names = False
+
+set_type_checking_flag = False
+typehints_fully_qualified = False
+always_document_param_types = False
+typehints_document_rtype = False
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+}
+
+os.environ["CG_EAGERIMPORT"] = "True"
+os.environ["CG_GENERATING_DOCS"] = "True"

codegrade-17.0.49/docs/models/CreateEntryTicketRestrictionData.rst

@@ -0,0 +1,9 @@
+CreateEntryTicketRestrictionData
+================================
+
+.. currentmodule:: codegrade.models.create_entry_ticket_restriction_data
+
+.. autoclass:: CreateEntryTicketRestrictionData
+   :members: password
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.49/docs/models/EntryTicketEnterData.rst

@@ -0,0 +1,9 @@
+EntryTicketEnterData
+====================
+
+.. currentmodule:: codegrade.models.entry_ticket_enter_data
+
+.. autoclass:: EntryTicketEnterData
+   :members: entry_ticket
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.49/docs/models/EntryTicketResponse.rst

@@ -0,0 +1,9 @@
+EntryTicketResponse
+===================
+
+.. currentmodule:: codegrade.models.entry_ticket_response
+
+.. autoclass:: EntryTicketResponse
+   :members: tag, ticket
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.49/docs/models/ParseErrorAllOf.rst

@@ -0,0 +1,9 @@
+ParseErrorAllOf
+===============
+
+.. currentmodule:: codegrade.models.parse_error_all_of
+
+.. autoclass:: ParseErrorAllOf
+   :members: kind, errors, total_errors, truncated
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.49/docs/models/ParseErrorAnyOf.rst

@@ -0,0 +1,9 @@
+ParseErrorAnyOf
+===============
+
+.. currentmodule:: codegrade.models.parse_error_any_of
+
+.. autoclass:: ParseErrorAnyOf
+   :members: kind, branches
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.49/docs/models/ParseErrorAt.rst

@@ -0,0 +1,9 @@
+ParseErrorAt
+============
+
+.. currentmodule:: codegrade.models.parse_error_at
+
+.. autoclass:: ParseErrorAt
+   :members: kind, segment, error
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.49/docs/models/ParseErrorFound.rst

@@ -0,0 +1,9 @@
+ParseErrorFound
+===============
+
+.. currentmodule:: codegrade.models.parse_error_found
+
+.. autoclass:: ParseErrorFound
+   :members: type, value
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.49/docs/models/ParseErrorLeaf.rst

@@ -0,0 +1,9 @@
+ParseErrorLeaf
+==============
+
+.. currentmodule:: codegrade.models.parse_error_leaf
+
+.. autoclass:: ParseErrorLeaf
+   :members: kind, expected, found, extra
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.49/docs/models/PasswordEnterData.rst

@@ -0,0 +1,9 @@
+PasswordEnterData
+=================
+
+.. currentmodule:: codegrade.models.password_enter_data
+
+.. autoclass:: PasswordEnterData
+   :members: password
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.49/docs/services/restriction.rst

@@ -0,0 +1,24 @@
+
+RestrictionService
+==================
+
+.. currentmodule:: codegrade._api.restriction
+
+.. autoclass:: RestrictionService
+   :members: create_entry_ticket, put_allowed_ip, delete_allowed_ip, get_all_entries, enter, get_all_allowed_ips, get, patch, patch_entry_override, heartbeat
+
+	 .. rubric:: Methods
+
+	 .. autosummary::
+	    :nosignatures:
+
+			~RestrictionService.create_entry_ticket
+			~RestrictionService.put_allowed_ip
+			~RestrictionService.delete_allowed_ip
+			~RestrictionService.get_all_entries
+			~RestrictionService.enter
+			~RestrictionService.get_all_allowed_ips
+			~RestrictionService.get
+			~RestrictionService.patch
+			~RestrictionService.patch_entry_override
+			~RestrictionService.heartbeat

codegrade-17.0.49/pyproject.toml

@@ -0,0 +1,64 @@
+[project]
+name = "codegrade"
+version = "17.0.49"
+description = "A client library for accessing CodeGrade"
+authors = []
+requires-python = ">=3.12,<4.0"
+readme = "README.md"
+license = "AGPL-3.0-only OR BSD-3-Clause-Clear"
+dependencies = [
+  "httpx>=0.19.0, <1.0.0",
+  "structlog>=20.1.0",
+  "validate-email~=1.3",
+  "python-dateutil>=2.8.1,<3",
+  "typing-extensions>=4.13.2,<5",
+]
+
+[project.urls]
+Documentation = "https://python.api.codegrade.com"
+
+[dependency-groups]
+dev = [
+  "mypy>=1.9.1,<2",
+  "sphinx>=9,<10",
+  "sphinx-autodoc-typehints>=1.23.0,<2",
+  "myst-parser>=5,<6",
+  "setuptools>=78.1.1,<79",
+  "furo>=2024,<2026",
+  "docutils>=0.20.0,<1.0",
+  "ruff>=0.11.10",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = [
+  "src/codegrade",
+  "src/cg_maybe",
+  "src/cg_dt_utils",
+  "src/cg_request_args",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.deptry.per_rule_ignores]
+DEP002 = [
+  "validate-email",
+  "python-dateutil",
+]
+DEP003 = [
+  "cg_request_args",
+  "cg_maybe",
+]
+
+[tool.ruff]
+line-length = 79
+preview = true
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.ruff.lint]
+preview = true
+fixable = ["ALL"]
+select = ["E2", "E9", "I"]

codegrade-17.0.49/src/cg_request_args/__init__.py

@@ -0,0 +1,70 @@
+"""This module defines parsers and validators for JSON data."""
+
+from ._any_value import AnyValue as AnyValue
+from ._base import Parser as Parser
+from ._base import SimpleValue as SimpleValue
+from ._base import Union as Union
+from ._convert import (
+    ConvertCtx as ConvertCtx,
+)
+from ._convert import (
+    ConvertPriority as ConvertPriority,
+)
+from ._convert import (
+    as_converter as as_converter,
+)
+from ._doc import Doc as Doc
+from ._enum import EnumValue as EnumValue
+from ._enum import SingleEnumValue as SingleEnumValue
+from ._enum import StringEnum as StringEnum
+from ._enum import StringLiteralAsEnum as StringLiteralAsEnum
+from ._form import FormURLEncoded as FormURLEncoded
+from ._lazy import Lazy as Lazy
+from ._list import List as List
+from ._list import ListSizeRestrictions as ListSizeRestrictions
+from ._list import TwoTuple as TwoTuple
+from ._literal import LiteralBoolean as LiteralBoolean
+from ._mapping import (
+    BaseFixedMapping as BaseFixedMapping,
+)
+from ._mapping import (
+    DefaultArgument as DefaultArgument,
+)
+from ._mapping import (
+    FixedMapping as FixedMapping,
+)
+from ._mapping import (
+    LookupMapping as LookupMapping,
+)
+from ._mapping import (
+    OnExtraAction as OnExtraAction,
+)
+from ._mapping import (
+    OptionalArgument as OptionalArgument,
+)
+from ._mapping import (
+    RequiredArgument as RequiredArgument,
+)
+from ._mapping import (
+    _DictGetter as _DictGetter,
+)
+from ._multipart import (
+    ExactMultipartUploadWithData as ExactMultipartUploadWithData,
+)
+from ._multipart import (
+    MultipartUploadWithData as MultipartUploadWithData,
+)
+from ._multipart import (
+    MultipartUploadWithoutData as MultipartUploadWithoutData,
+)
+from ._nullable import Nullable as Nullable
+from ._octet_stream import (
+    OctetStreamUpload as OctetStreamUpload,
+)
+from ._parse_utils import Transform as Transform
+from ._query import QueryParam as QueryParam
+from ._rich_value import RichValue as RichValue
+from ._set import Set as Set
+from ._swagger_utils import OpenAPISchema as OpenAPISchema
+from ._swaggerize import swaggerize as swaggerize
+from .exceptions import ParseError as ParseError