codegrade 17.0.53__tar.gz → 17.0.55__tar.gz

codegrade-17.0.55/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: codegrade
+Version: 17.0.55
+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.55/docs/conf.py

@@ -0,0 +1,170 @@
+# 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
+from typing import Any
+
+from sphinx.application import Sphinx
+from sphinx.ext.autodoc import Options
+
+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.55"
+# 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.55"
+
+# -- 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"
+
+
+def _escape_kwonly_marker_in_docstring(
+    app: Sphinx,
+    what: str,
+    name: str,
+    obj: Any,
+    options: Options,
+    lines: list[str],
+) -> None:
+    """Escape the ``*,`` kw-only marker inside synthesized class docstrings.
+
+    For a ``@dataclass(kw_only=True)`` with no explicit docstring, CPython's
+    dataclass decorator synthesizes a class docstring from the ``__init__``
+    signature -- something like ``ClassName(*, name: ..., value: ...)``. The
+    bare ``*`` would otherwise be parsed by docutils as the start of an
+    inline-emphasis run that never terminates, raising "Inline emphasis
+    start-string without end-string". Escape it.
+    """
+    for i, line in enumerate(lines):
+        if "(*, " in line or ", *, " in line:
+            lines[i] = line.replace("(*, ", r"(\*, ").replace(
+                ", *, ", r", \*, "
+            )
+
+
+def setup(app: Sphinx) -> None:
+    app.connect(
+        "autodoc-process-docstring", _escape_kwonly_marker_in_docstring
+    )

codegrade-17.0.55/docs/models/BaseEnrollData.rst

@@ -0,0 +1,9 @@
+BaseEnrollData
+==============
+
+.. currentmodule:: codegrade.models.base_enroll_data
+
+.. autoclass:: BaseEnrollData
+   :members: role_id
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.55/docs/models/BaseImpersonateData.rst

@@ -0,0 +1,9 @@
+BaseImpersonateData
+===================
+
+.. currentmodule:: codegrade.models.base_impersonate_data
+
+.. autoclass:: BaseImpersonateData
+   :members: own_password, mode
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.55/docs/models/BaseLoginData.rst

@@ -0,0 +1,9 @@
+BaseLoginData
+=============
+
+.. currentmodule:: codegrade.models.base_login_data
+
+.. autoclass:: BaseLoginData
+   :members: confirm_session_termination
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.55/docs/models/EnrollDataById.rst

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

codegrade-17.0.55/docs/models/EnrollDataByUsername.rst

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

codegrade-17.0.55/docs/models/GlobalPermMap.rst

@@ -0,0 +1,9 @@
+GlobalPermMap
+=============
+
+.. currentmodule:: codegrade.models.global_perm_map
+
+.. autoclass:: GlobalPermMap
+   :members: can_create_courses_in_all_tenants, can_edit_coupons, can_edit_pricing, can_impersonate_users, can_list_hidden_tenants, can_manage_all_community_library_items, can_manage_background_jobs, can_manage_git_connections_in_all_tenants, can_manage_global_roles, can_manage_lti_providers, can_manage_pearson_templates, can_manage_quarantined_registrations, can_manage_site_settings, can_manage_sso_providers, can_manage_tenant_roles_in_all_tenants, can_manage_tenants, can_search_users_in_all_tenants, can_see_all_transactions, can_see_coupons, can_see_statistics_in_all_tenants, can_skip_payment_in_all_tenants, can_view_usernames_in_all_tenants, is_global_admin
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.55/docs/models/GlobalPermission.rst

@@ -0,0 +1,32 @@
+GlobalPermission
+================
+
+.. currentmodule:: codegrade.models.global_permission
+
+.. class:: GlobalPermission
+
+**Options**
+
+* ``can_create_courses_in_all_tenants``
+* ``can_edit_coupons``
+* ``can_edit_pricing``
+* ``can_impersonate_users``
+* ``can_list_hidden_tenants``
+* ``can_manage_all_community_library_items``
+* ``can_manage_background_jobs``
+* ``can_manage_git_connections_in_all_tenants``
+* ``can_manage_global_roles``
+* ``can_manage_lti_providers``
+* ``can_manage_pearson_templates``
+* ``can_manage_quarantined_registrations``
+* ``can_manage_site_settings``
+* ``can_manage_sso_providers``
+* ``can_manage_tenant_roles_in_all_tenants``
+* ``can_manage_tenants``
+* ``can_search_users_in_all_tenants``
+* ``can_see_all_transactions``
+* ``can_see_coupons``
+* ``can_see_statistics_in_all_tenants``
+* ``can_skip_payment_in_all_tenants``
+* ``can_view_usernames_in_all_tenants``
+* ``is_global_admin``

codegrade-17.0.55/docs/models/ImpersonateById.rst

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

codegrade-17.0.55/docs/models/ImpersonateByUsername.rst

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

codegrade-17.0.55/docs/models/LoginByUsernameData.rst

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

codegrade-17.0.55/docs/models/TenantPermMap.rst

@@ -0,0 +1,9 @@
+TenantPermMap
+=============
+
+.. currentmodule:: codegrade.models.tenant_perm_map
+
+.. autoclass:: TenantPermMap
+   :members: can_add_users, can_create_community_library_items, can_create_courses, can_delete_community_library_items, can_login_outside_lti, can_login_outside_sso, can_manage_tenant_roles, can_search_users, can_see_tenant_statistics, can_skip_payment, can_use_password, can_use_snippets, can_view_community_library_items, can_view_usernames, is_tenant_admin
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.55/docs/models/TenantPermission.rst

@@ -0,0 +1,24 @@
+TenantPermission
+================
+
+.. currentmodule:: codegrade.models.tenant_permission
+
+.. class:: TenantPermission
+
+**Options**
+
+* ``can_add_users``
+* ``can_create_community_library_items``
+* ``can_create_courses``
+* ``can_delete_community_library_items``
+* ``can_login_outside_lti``
+* ``can_login_outside_sso``
+* ``can_manage_tenant_roles``
+* ``can_search_users``
+* ``can_see_tenant_statistics``
+* ``can_skip_payment``
+* ``can_use_password``
+* ``can_use_snippets``
+* ``can_view_community_library_items``
+* ``can_view_usernames``
+* ``is_tenant_admin``

codegrade-17.0.55/docs/models/UserInputById.rst

@@ -0,0 +1,9 @@
+UserInputById
+=============
+
+.. currentmodule:: codegrade.models.user_input_by_id
+
+.. autoclass:: UserInputById
+   :members: user_id, by
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.55/docs/models/UserInputByUsername.rst

@@ -0,0 +1,9 @@
+UserInputByUsername
+===================
+
+.. currentmodule:: codegrade.models.user_input_by_username
+
+.. autoclass:: UserInputByUsername
+   :members: username, tenant_id, by
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.55/pyproject.toml

@@ -0,0 +1,64 @@
+[project]
+name = "codegrade"
+version = "17.0.55"
+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.55/src/codegrade/__init__.py

@@ -0,0 +1,120 @@
+"""A client library for accessing CodeGrade
+
+SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
+"""
+
+import typing as _t
+from functools import wraps as _wraps
+
+from . import paginated as paginated
+from .client import AuthenticatedClient, Client
+
+try:
+    from typing import ParamSpec as _ParamSpec
+except ImportError:
+    from typing_extensions import (
+        ParamSpec as _ParamSpec,
+    )
+
+__all__ = ("login", "AuthenticatedClient", "Client", "login_from_cli")
+__version__ = "17.0.55"
+
+_P = _ParamSpec("_P")
+_T = _t.TypeVar("_T")
+
+
+def _copy_func(func: _t.Callable[_P, _T]) -> _t.Callable[_P, _T]:
+    @_wraps(func)
+    def wrapper(*args: _P.args, **kwargs: _P.kwargs) -> _T:
+        return func(*args, **kwargs)
+
+    return wrapper
+
+
+login = _copy_func(AuthenticatedClient.get)
+
+login_from_cli = _copy_func(AuthenticatedClient.get_from_cli)
+
+login_from_cli_for_course = _copy_func(
+    AuthenticatedClient.get_from_cli_for_course
+)
+
+
+login.__name__ = "login"
+login.__doc__ = """Get an :class:`.AuthenticatedClient` by logging in with your
+    username and password.
+
+    .. code-block:: python
+
+        with codegrade.login(
+            username='my-username',
+            password=os.getenv('CG_PASS'),
+            tenant='My University',
+        ) as client:
+            print('Hi I am {}'.format(client.user.get().name)
+
+    :param username: Your CodeGrade username.
+    :param password: Your CodeGrade password, if you do not know your
+        password you can set it by following `these steps.
+        <https://help.codegrade.com/faq/setting-up-a-password-for-my-account>`_
+    :param tenant: The id or name of your tenant in CodeGrade. This is the
+        name you click on the login screen.
+    :param host: The CodeGrade instance you want to use.
+
+    :returns: A client that you can use to do authenticated requests to
+              CodeGrade. We advise you to use it in combination with a
+              ``with`` block (i.e. as a contextmanager) for the highest
+              efficiency.
+    """
+
+login_from_cli.__name__ = "login_from_cli"
+login_from_cli.__doc__ = """Get an :class:`.AuthenticatedClient` by logging in through command
+    line interface.
+
+    .. code-block::
+
+        >>> import codegrade
+        >>> codegrade.login_from_cli()
+        Your instance [default: https://app.codegra.de]: https://app.codegra.de
+        [ 1] CodeGrade Sandbox
+        [ 2] Academy of Interactive Entertainment
+        ...
+        Select your tenant: 1
+        Selecting CodeGrade Sandbox
+        Your username: my-username
+        Your password:
+        <codegrade.client.AuthenticatedClient object at 0x106f139a0>
+
+    :returns: A client that you can use to do authenticated requests to
+              CodeGrade. We advise you to use it in combination with a
+              ``with`` block (i.e. as a contextmanager) for the highest
+              efficiency.
+    """
+
+login_from_cli_for_course.__name__ = "login_from_cli_for_course"
+login_from_cli_for_course.__doc__ = """Get an :class:`.AuthenticatedClient` with permissions restricted to a single
+    course by logging in through command line interface.
+
+    .. code-block::
+
+        >>> import codegrade
+        >>> codegrade.login_from_cli_for_course()
+        Your instance [default: https://app.codegra.de]: https://app.codegra.de
+        [ 1] CodeGrade Sandbox
+        [ 2] Academy of Interactive Entertainment
+        ...
+        Select your tenant: 1
+        Selecting CodeGrade Sandbox
+        Your username: my-username
+        Your password:
+        [ 1] Introduction to Programming
+        [ 2] Advanced Operating Systems
+        ...
+        Select your course: 2
+        <codegrade.client.AuthenticatedClient object at 0x106f139a0>
+
+    :returns: A client that you can use to do authenticated requests to
+              CodeGrade, limited in scope to a single course. We advise
+              you to use it in combination with a ``with`` block (i.e.
+              as a contextmanager) for the highest efficiency.
+    """