{"id":21855831,"url":"https://github.com/mark7888/pyspiget","last_synced_at":"2026-02-11T19:03:32.797Z","repository":{"id":264366799,"uuid":"893155264","full_name":"Mark7888/pyspiget","owner":"Mark7888","description":"A python wrapper for the Spiget API","archived":false,"fork":false,"pushed_at":"2024-11-23T19:26:37.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-06T14:59:08.618Z","etag":null,"topics":["pypi","pypi-package","python","python3","spiget","spiget-api","spigot","spigot-api"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Mark7888.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-11-23T17:18:50.000Z","updated_at":"2024-11-23T19:44:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"cf88a4a5-e3ad-47a3-a014-4792a333e000","html_url":"https://github.com/Mark7888/pyspiget","commit_stats":null,"previous_names":["mark7888/pyspiget"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/Mark7888/pyspiget","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mark7888%2Fpyspiget","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mark7888%2Fpyspiget/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mark7888%2Fpyspiget/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mark7888%2Fpyspiget/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mark7888","download_url":"https://codeload.github.com/Mark7888/pyspiget/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mark7888%2Fpyspiget/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29341709,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T18:58:20.535Z","status":"ssl_error","status_checked_at":"2026-02-11T18:56:44.814Z","response_time":97,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pypi","pypi-package","python","python3","spiget","spiget-api","spigot","spigot-api"],"created_at":"2024-11-28T02:18:57.902Z","updated_at":"2026-02-11T19:03:32.792Z","avatar_url":"https://github.com/Mark7888.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![publish](https://github.com/Mark7888/pyspiget/actions/workflows/publish.yml/badge.svg?event=push)](https://github.com/Mark7888/pyspiget/actions/workflows/publish.yml)\n[![Downloads](https://static.pepy.tech/badge/pyspiget)](https://pepy.tech/project/pyspiget)\n\n# Python Spiget API Wrapper\n\nA modern Python wrapper for the [Spiget API](https://spiget.org/), providing easy access to Spigot resources, authors, and categories.\n\n## Installation\n\n```bash\npip install pyspiget\n```\n\n## Quick Start\n\n```python\nfrom spiget import Spiget\n\n# Initialize the client\napi = Spiget(user_agent=\"MyApp/1.0.0\")\n\n# Get a resource\nresource = api.get_resource(1234)\nprint(f\"Resource name: {resource.name}\")\n\n# Search for resources\nresources = api.search_resources(\"worldedit\")\nfor resource in resources:\n    print(f\"Found: {resource.name}\")\n```\n\n## API Reference\n\n### Main Classes\n\n#### `Spiget`\n\nThe main class for interacting with the Spiget API.\n\n```python\napi = Spiget(user_agent=\"MyApp/1.0.0\")\n```\n\n#### `WebhookHandler`\n\nHandles webhook-related operations for the Spiget API.\n\n```python\nwebhook_handler = WebhookHandler(api.session)\n```\n\n### Data Models\n\nAll models inherit from `BaseModel` which provides basic dictionary to object conversion.\n\n#### `Resource`\nRepresents a Spigot resource (plugin, mod, etc.)\n\nProperties:\n- `id`: Resource ID\n- `name`: Resource name\n- `tag`: Resource tag\n- `contributors`: List of contributors\n- `likes`: Number of likes\n- `file`: ResourceFile object\n- `tested_versions`: List of tested Minecraft versions\n- `links`: Dictionary of related links\n- `rating`: ResourceRating object\n- `release_date`: Release datetime\n- `update_date`: Last update datetime\n- `downloads`: Number of downloads\n- `external`: Whether the resource is external\n- `icon`: Icon object\n- `premium`: Whether the resource is premium\n- `price`: Resource price (if premium)\n- `currency`: Price currency\n- `description`: Resource description\n- `documentation`: Resource documentation\n- `source_code_link`: Link to source code\n- `donation_link`: Link to donation page\n\n#### `ResourceFile`\nRepresents a resource's downloadable file.\n\nProperties:\n- `type`: File type\n- `size`: File size\n- `size_unit`: Size unit\n- `url`: Download URL\n- `external_url`: External download URL\n\n#### `ResourceVersion`\nRepresents a specific version of a resource.\n\nProperties:\n- `id`: Version ID\n- `uuid`: Version UUID\n- `name`: Version name\n- `release_date`: Release datetime\n- `downloads`: Number of downloads\n- `rating`: ResourceRating object\n\n#### `ResourceUpdate`\nRepresents an update post for a resource.\n\nProperties:\n- `id`: Update ID\n- `resource`: Resource ID\n- `title`: Update title\n- `description`: Update description\n- `date`: Update datetime\n- `likes`: Number of likes\n\n#### `ResourceReview`\nRepresents a review for a resource.\n\nProperties:\n- `author`: Author object\n- `rating`: ResourceRating object\n- `message`: Review message\n- `response_message`: Author's response\n- `version`: Version reviewed\n- `date`: Review datetime\n\n#### `Author`\nRepresents a resource author.\n\nProperties:\n- `id`: Author ID\n- `name`: Author name\n- `icon`: Icon object\n\n#### `Category`\nRepresents a resource category.\n\nProperties:\n- `id`: Category ID\n- `name`: Category name\n\n### Methods\n\n#### Resource Methods\n\n```python\n# Get multiple resources\nresources = api.get_resources(size=10, page=1, sort=None, fields=None)\n\n# Get a single resource\nresource = api.get_resource(resource_id=1234)\n\n# Get resource versions\nversions = api.get_resource_versions(resource_id=1234, size=10, page=1)\n\n# Get specific version\nversion = api.get_resource_version(resource_id=1234, version_id=\"1.0.0\")\n\n# Get latest version\nlatest = api.get_resource_latest_version(resource_id=1234)\n\n# Get resource updates\nupdates = api.get_resource_updates(resource_id=1234, size=10, page=1)\n\n# Get resource reviews\nreviews = api.get_resource_reviews(resource_id=1234, size=10, page=1)\n\n# Get resource author\nauthor = api.get_resource_author(resource_id=1234)\n```\n\n#### Author Methods\n\n```python\n# Get multiple authors\nauthors = api.get_authors(size=10, page=1)\n\n# Get single author\nauthor = api.get_author(author_id=1234)\n\n# Get author's resources\nresources = api.get_author_resources(author_id=1234, size=10, page=1)\n```\n\n#### Category Methods\n\n```python\n# Get all categories\ncategories = api.get_categories(size=10, page=1)\n\n# Get single category\ncategory = api.get_category(category_id=1234)\n\n# Get category resources\nresources = api.get_category_resources(category_id=1234, size=10, page=1)\n```\n\n#### Search Methods\n\n```python\n# Search resources\nresources = api.search_resources(query=\"worldedit\", field=None, size=10, page=1)\n\n# Search authors\nauthors = api.search_authors(query=\"sk89q\", field=None, size=10, page=1)\n```\n\n#### Webhook Methods\n\n```python\n# Get available webhook events\nevents = webhook_handler.get_webhook_events()\n\n# Register a webhook\nwebhook = webhook_handler.register_webhook(\n    url=\"https://example.com/webhook\",\n    events=[\"resource-update\", \"new-resource\"]\n)\n\n# Get webhook status\nstatus = webhook_handler.get_webhook_status(webhook_id=\"abc123\")\n\n# Delete webhook\nwebhook_handler.delete_webhook(webhook_id=\"abc123\", secret=\"webhook_secret\")\n```\n\n## Error Handling\n\nThe wrapper includes a custom `SpigetError` exception that is raised when API requests fail:\n\n```python\nfrom spiget import Spiget, SpigetError\n\napi = Spiget()\n\ntry:\n    resource = api.get_resource(99999999)\nexcept SpigetError as e:\n    print(f\"API error: {e}\")\n```\n\n## Credits\n\nThis wrapper is built for the [Spiget API](https://spiget.org/) created by the [SpiGetOrg team](https://github.com/SpiGetOrg).\n\n## License\n\nMIT License - see LICENSE file for details\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmark7888%2Fpyspiget","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmark7888%2Fpyspiget","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmark7888%2Fpyspiget/lists"}