Run stubgen

Author: RevolvingMadness

out/pyrinth/__init__.pyi

@@ -0,0 +1,6 @@
+from pyrinth.models import *
+from pyrinth.modrinth import *
+from pyrinth.projects import *
+from pyrinth.tags import *
+from pyrinth.users import *
+from pyrinth.teams import *

out/pyrinth/exceptions.pyi

@@ -0,0 +1,11 @@
+class NotFoundError(Exception):
+    def __init__(self, *args: object) -> None: ...
+
+class InvalidRequestError(Exception):
+    def __init__(self, reason) -> None: ...
+
+class NoAuthorizationError(Exception):
+    def __init__(self, *args: object) -> None: ...
+
+class InvalidParamError(Exception):
+    def __init__(self, *args: object) -> None: ...

out/pyrinth/literals.pyi

@@ -0,0 +1,12 @@
+from _typeshed import Incomplete
+
+index_literal: Incomplete
+side_literal: Incomplete
+version_status_literal: Incomplete
+requested_version_status_literal: Incomplete
+project_status_literal: Incomplete
+requested_project_status_literal: Incomplete
+version_type_literal: Incomplete
+project_type_literal: Incomplete
+user_role_literal: Incomplete
+sha_algorithm_literal: Incomplete

out/pyrinth/models.pyi

@@ -0,0 +1,95 @@
+import pyrinth.literals as literals
+import pyrinth.projects as projects
+from _typeshed import Incomplete
+
+class ProjectModel:
+    slug: Incomplete
+    title: Incomplete
+    description: Incomplete
+    categories: Incomplete
+    client_side: Incomplete
+    server_side: Incomplete
+    body: Incomplete
+    license: Incomplete
+    project_type: Incomplete
+    additional_categories: Incomplete
+    issues_url: Incomplete
+    source_url: Incomplete
+    wiki_url: Incomplete
+    discord_url: Incomplete
+    donation_urls: Incomplete
+    auth: Incomplete
+    id: Incomplete
+    downloads: Incomplete
+    icon_url: Incomplete
+    color: Incomplete
+    team: Incomplete
+    moderator_message: Incomplete
+    published: Incomplete
+    updated: Incomplete
+    approved: Incomplete
+    followers: Incomplete
+    status: Incomplete
+    version_ids: Incomplete
+    game_versions: Incomplete
+    loaders: Incomplete
+    gallery: Incomplete
+    def __init__(self, slug: str, title: str, description: str, categories: list[str], client_side: str, server_side: str, body: str, license_: projects.Project.License, project_type: str, additional_categories: list[str] | None = ..., issues_url: str | None = ..., source_url: str | None = ..., wiki_url: str | None = ..., discord_url: str | None = ..., auth: str | None = ...) -> None: ...
+
+class SearchResultModel:
+    slug: Incomplete
+    title: Incomplete
+    description: Incomplete
+    client_side: Incomplete
+    server_side: Incomplete
+    project_type: Incomplete
+    downloads: Incomplete
+    project_id: Incomplete
+    author: Incomplete
+    versions: Incomplete
+    follows: Incomplete
+    date_created: Incomplete
+    date_modified: Incomplete
+    license: Incomplete
+    categories: Incomplete
+    icon_url: Incomplete
+    color: Incomplete
+    display_categories: Incomplete
+    latest_version: Incomplete
+    gallery: Incomplete
+    featured_gallery: Incomplete
+    def __init__(self) -> None: ...
+
+class VersionModel:
+    name: Incomplete
+    version_number: Incomplete
+    changelog: Incomplete
+    dependencies: Incomplete
+    game_versions: Incomplete
+    version_type: Incomplete
+    loaders: Incomplete
+    featured: Incomplete
+    status: Incomplete
+    requested_status: Incomplete
+    files: Incomplete
+    project_id: Incomplete
+    id: Incomplete
+    author_id: Incomplete
+    date_published: Incomplete
+    downloads: Incomplete
+    def __init__(self, name: str, version_number: str, dependencies: list['projects.Project.Dependency'], game_versions: list[str], version_type: literals.version_type_literal, loaders: list[str], featured: bool, file_parts: list[str], changelog: str | None = ..., status: literals.version_status_literal | None = ..., requested_status: literals.requested_version_status_literal | None = ...) -> None: ...
+
+class UserModel:
+    username: Incomplete
+    id: Incomplete
+    avatar_url: Incomplete
+    created: Incomplete
+    role: Incomplete
+    name: Incomplete
+    email: Incomplete
+    bio: Incomplete
+    payout_data: Incomplete
+    github_id: Incomplete
+    badges: Incomplete
+    auth: Incomplete
+    def __init__(self) -> None: ...

out/pyrinth/modrinth.pyi

@@ -0,0 +1,14 @@
+import pyrinth.projects as projects
+from _typeshed import Incomplete
+
+class Modrinth:
+    @staticmethod
+    def project_exists(id_: str) -> bool: ...
+    @staticmethod
+    def get_random_projects(count: int = ...) -> list['projects.Project']: ...
+    class Statistics:
+        authors: Incomplete
+        files: Incomplete
+        projects: Incomplete
+        versions: Incomplete
+        def __init__(self) -> None: ...

out/pyrinth/projects.pyi

@@ -0,0 +1,109 @@
+import datetime as dt
+import pyrinth.literals as literals
+import pyrinth.models as models
+import pyrinth.teams as teams
+import typing
+import pyrinth.users as users
+from _typeshed import Incomplete
+
+class Project:
+    model: Incomplete
+    def __init__(self, project_model: models.ProjectModel) -> None: ...
+    def get_donations(self) -> list['Project.Donation']: ...
+    @staticmethod
+    def get(id_: str, auth: object = ...) -> Project: ...
+    @staticmethod
+    def get_multiple(ids: list[str]) -> list['Project']: ...
+    def get_latest_version(self, loaders: list[str] | None = ..., game_versions: list[str] | None = ..., featured: bool | None = ..., types: literals.version_type_literal | None = ..., auth: str | None = ...) -> Project.Version: ...
+    def get_gallery(self) -> list['Project.GalleryImage']: ...
+    def is_client_side(self) -> bool: ...
+    def is_server_side(self) -> bool: ...
+    def get_downloads(self) -> int: ...
+    def get_categories(self) -> list[str]: ...
+    def get_additional_categories(self) -> list[str]: ...
+    def get_all_categories(self) -> list[str]: ...
+    def get_license(self) -> Project.License: ...
+    def get_specific_version(self, semantic_version: str) -> typing.Optional['Project.Version']: ...
+    def download(self, recursive: bool = ...) -> None: ...
+    def get_versions(self, loaders: list[str] | None = ..., game_versions: list[str] | None = ..., featured: bool | None = ..., types: literals.version_type_literal | None = ..., auth: str | None = ...) -> list['Project.Version']: ...
+    def get_oldest_version(self, loaders: list[str] | None = ..., game_versions: list[str] | None = ..., featured: bool | None = ..., types: literals.version_type_literal | None = ..., auth: str | None = ...) -> Project.Version: ...
+    def get_id(self) -> str: ...
+    def get_slug(self) -> str: ...
+    def get_name(self) -> str: ...
+    @staticmethod
+    def get_version(id_: str) -> Project.Version: ...
+    def create_version(self, version_model, auth: str | None = ...) -> int: ...
+    def change_icon(self, file_path: str, auth: str | None = ...) -> bool: ...
+    def delete_icon(self, auth: str | None = ...) -> bool: ...
+    def add_gallery_image(self, image: Project.GalleryImage, auth: str | None = ...) -> bool: ...
+    def modify_gallery_image(self, url: str, featured: bool | None = ..., title: str | None = ..., description: str | None = ..., ordering: int | None = ..., auth: str | None = ...) -> bool: ...
+    def delete_gallery_image(self, url: str, auth: str | None = ...) -> bool: ...
+    def modify(self, slug: str | None = ..., title: str | None = ..., description: str | None = ..., categories: list[str] | None = ..., client_side: str | None = ..., server_side: str | None = ..., body: str | None = ..., additional_categories: list[str] | None = ..., issues_url: str | None = ..., source_url: str | None = ..., wiki_url: str | None = ..., discord_url: str | None = ..., license_id: str | None = ..., license_url: str | None = ..., status: literals.project_status_literal | None = ..., requested_status: literals.requested_project_status_literal | None = ..., moderation_message: str | None = ..., moderation_message_body: str | None = ..., auth: str | None = ...) -> bool: ...
+    def delete(self, auth: str | None = ...) -> typing.Literal[True]: ...
+    def get_dependencies(self) -> list['Project']: ...
+    @staticmethod
+    def search(query: str = ..., facets: list[list[str]] | None = ..., index: literals.index_literal = ..., offset: int = ..., limit: int = ..., filters: list[str] | None = ...) -> list['Project.SearchResult']: ...
+    def get_team_members(self) -> list[teams.Team.TeamMember]: ...
+    def get_team(self) -> teams.Team: ...
+    class Version:
+        model: Incomplete
+        def __init__(self, version_model: models.VersionModel) -> None: ...
+        def get_type(self) -> str: ...
+        def get_dependencies(self) -> list['Project.Dependency']: ...
+        @staticmethod
+        def get(id_: str) -> Project.Version: ...
+        @staticmethod
+        def get_from_hash(hash_: str, algorithm: literals.sha_algorithm_literal = ..., multiple: bool = ...) -> typing.Union['Project.Version', list['Project.Version']]: ...
+        @staticmethod
+        def delete_file_from_hash(auth: str, hash_: str, version_id: str, algorithm: literals.sha_algorithm_literal = ...) -> typing.Literal[True]: ...
+        def get_files(self) -> list['Project.File']: ...
+        def download(self, recursive: bool = ...) -> None: ...
+        def get_project(self) -> Project: ...
+        def get_primary_files(self) -> list['Project.File']: ...
+        def get_author(self) -> users.User: ...
+        def is_featured(self) -> bool: ...
+        def get_date_published(self) -> dt.datetime: ...
+        def get_downloads(self) -> int: ...
+        def get_name(self) -> str: ...
+        def get_version_number(self) -> str: ...
+    class GalleryImage:
+        file_path: Incomplete
+        ext: Incomplete
+        featured: Incomplete
+        title: Incomplete
+        description: Incomplete
+        ordering: Incomplete
+        def __init__(self, file_path: str, featured: bool, title: str, description: str, ordering: int = ...) -> None: ...
+    class File:
+        hashes: Incomplete
+        url: Incomplete
+        name: Incomplete
+        primary: Incomplete
+        size: Incomplete
+        file_type: Incomplete
+        extension: Incomplete
+        def __init__(self, hashes: dict[str, str], url: str, filename: str, primary: str, size: int, file_type: str) -> None: ...
+        def is_resourcepack(self) -> bool: ...
+    class License:
+        id: Incomplete
+        name: Incomplete
+        url: Incomplete
+        def __init__(self, id_: str, name: str, url: str | None = ...) -> None: ...
+    class Donation:
+        id: Incomplete
+        platform: Incomplete
+        url: Incomplete
+        def __init__(self, id_: str, platform: str, url: str) -> None: ...
+    class Dependency:
+        dependency_option: Incomplete
+        file_name: Incomplete
+        version_id: Incomplete
+        project_id: Incomplete
+        def __init__(self) -> None: ...
+        def get_version(self) -> Project.Version: ...
+        def is_required(self) -> bool: ...
+        def is_optional(self) -> bool: ...
+        def is_incompatible(self) -> bool: ...
+    class SearchResult:
+        model: Incomplete
+        def __init__(self, search_result_model: models.SearchResultModel) -> None: ...

out/pyrinth/tags.pyi

@@ -0,0 +1,40 @@
+from _typeshed import Incomplete
+
+class Tag:
+    @staticmethod
+    def get_categories() -> list['Tag.Category']: ...
+    @staticmethod
+    def get_loaders() -> list['Tag.Loader']: ...
+    @staticmethod
+    def get_game_versions() -> list['Tag.GameVersion']: ...
+    @staticmethod
+    def get_licenses() -> list['Tag.License']: ...
+    @staticmethod
+    def get_donation_platforms() -> list['Tag.DonationPlatform']: ...
+    @staticmethod
+    def get_report_types() -> list[str]: ...
+    class Category:
+        icon: Incomplete
+        name: Incomplete
+        project_type: Incomplete
+        header: Incomplete
+        def __init__(self, icon: str, name: str, project_type: str, header: str) -> None: ...
+    class Loader:
+        icon: Incomplete
+        name: Incomplete
+        supported_project_types: Incomplete
+        def __init__(self, icon: str, name: str, supported_project_types: list[str]) -> None: ...
+    class GameVersion:
+        version: Incomplete
+        version_type: Incomplete
+        date: Incomplete
+        major: Incomplete
+        def __init__(self, version: str, version_type: str, date: str, major: bool) -> None: ...
+    class License:
+        short: Incomplete
+        name: Incomplete
+        def __init__(self, short: str, name: str) -> None: ...
+    class DonationPlatform:
+        short: Incomplete
+        name: Incomplete
+        def __init__(self, short: str, name: str) -> None: ...

out/pyrinth/teams.pyi

@@ -0,0 +1,18 @@
+import pyrinth.users as users
+from _typeshed import Incomplete
+
+class Team:
+    members: Incomplete
+    id: Incomplete
+    def __init__(self) -> None: ...
+    def get_members(self) -> list['Team.TeamMember']: ...
+    class TeamMember:
+        team_id: Incomplete
+        user: Incomplete
+        role: Incomplete
+        permissions: Incomplete
+        accepted: Incomplete
+        payouts_split: Incomplete
+        ordering: Incomplete
+        def __init__(self, team_id: str, user: dict, role: str, permissions, accepted: bool, payouts_split, ordering: bool) -> None: ...
+        def get_user(self) -> users.User: ...

out/pyrinth/users.pyi

@@ -0,0 +1,46 @@
+import datetime as dt
+import pyrinth.models as models
+import pyrinth.projects as projects
+import typing
+from _typeshed import Incomplete
+
+class User:
+    model: Incomplete
+    def __init__(self, user_model: models.UserModel) -> None: ...
+    def get_auth(self) -> str | None: ...
+    def get_payout_history(self) -> User.PayoutHistory: ...
+    def withdraw_balance(self, amount: int) -> typing.Literal[True]: ...
+    def change_avatar(self, file_path) -> typing.Literal[True]: ...
+    @staticmethod
+    def get(id_: str, auth: Incomplete | None = ...) -> User: ...
+    def get_date_created(self) -> dt.datetime: ...
+    def get_followed_projects(self) -> list['projects.Project']: ...
+    def get_notifications(self) -> list['User.Notification']: ...
+    def get_amount_of_projects(self) -> int: ...
+    def create_project(self, project_model, icon: str | None = ...) -> int: ...
+    def get_projects(self) -> list['projects.Project']: ...
+    def follow_project(self, id_: str) -> int: ...
+    def unfollow_project(self, id_: str) -> int: ...
+    @staticmethod
+    def get_from_auth(auth: str) -> User: ...
+    @staticmethod
+    def from_id(id_: str) -> User: ...
+    @staticmethod
+    def from_ids(ids: list[str]) -> list['User']: ...
+    class Notification:
+        id: Incomplete
+        user_id: Incomplete
+        type: Incomplete
+        title: Incomplete
+        text: Incomplete
+        link: Incomplete
+        read: Incomplete
+        created: Incomplete
+        actions: Incomplete
+        project_title: Incomplete
+        def __init__(self, notification_json: dict) -> None: ...
+    class PayoutHistory:
+        all_time: Incomplete
+        last_month: Incomplete
+        payouts: Incomplete
+        def __init__(self, all_time: float, last_month: float, payouts: list) -> None: ...

out/pyrinth/util.pyi

@@ -0,0 +1,12 @@
+import datetime as dt
+import typing
+
+def to_sentence_case(sentence) -> typing.Any: ...
+def remove_null_values(json_: dict) -> dict: ...
+def to_image_from_json(json_: dict) -> list: ...
+def json_to_query_params(json_: dict) -> str: ...
+def remove_file_path(file) -> str: ...
+def list_to_json(lst: list) -> list[dict]: ...
+def list_to_object(type_, lst) -> list: ...
+def format_time(time) -> dt.datetime: ...
+def args_to_dict(**kwargs) -> str: ...