{"id":24127100,"url":"https://github.com/peterrauscher/py-gutenberg","last_synced_at":"2026-04-09T05:32:02.169Z","repository":{"id":149996122,"uuid":"622729032","full_name":"peterrauscher/py-gutenberg","owner":"peterrauscher","description":"A Python library to access the Project Gutenberg API","archived":false,"fork":false,"pushed_at":"2023-05-24T15:50:31.000Z","size":27,"stargazers_count":14,"open_issues_count":1,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-10T10:46:30.247Z","etag":null,"topics":["api-wrapper","gutenberg","project-gutenberg","python","python-libraries","python3"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/py-gutenberg","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/peterrauscher.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":"2023-04-02T23:57:06.000Z","updated_at":"2025-03-25T10:16:51.000Z","dependencies_parsed_at":null,"dependency_job_id":"7e1113f2-ebd7-4d1a-a59c-8506d17fc7a0","html_url":"https://github.com/peterrauscher/py-gutenberg","commit_stats":null,"previous_names":["peterrauscher/gutenberg-py"],"tags_count":1,"template":false,"template_full_name":"tomchen/example_pypi_package","purl":"pkg:github/peterrauscher/py-gutenberg","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterrauscher%2Fpy-gutenberg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterrauscher%2Fpy-gutenberg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterrauscher%2Fpy-gutenberg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterrauscher%2Fpy-gutenberg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peterrauscher","download_url":"https://codeload.github.com/peterrauscher/py-gutenberg/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterrauscher%2Fpy-gutenberg/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31587797,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"online","status_checked_at":"2026-04-09T02:00:06.848Z","response_time":112,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["api-wrapper","gutenberg","project-gutenberg","python","python-libraries","python3"],"created_at":"2025-01-11T17:39:04.650Z","updated_at":"2026-04-09T05:32:02.141Z","avatar_url":"https://github.com/peterrauscher.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# py-gutenberg\n\n[![Install from pip](https://img.shields.io/badge/pip%20install-py--gutenberg-orange)](https://pypi.org/project/py-gutenberg/) [![Tests Status](https://img.shields.io/github/actions/workflow/status/peterrauscher/py-gutenberg/test.yml?branch=main\u0026label=tests)](https://github.com/peterrauscher/py-gutenberg/actions) [![Build Status](https://img.shields.io/github/actions/workflow/status/peterrauscher/py-gutenberg/release.yml?branch=main\u0026label=build)](https://github.com/peterrauscher/py-gutenberg/actions) [![License](https://img.shields.io/github/license/peterrauscher/py-gutenberg)](https://github.com/peterrauscher/py-gutenberg/blob/main/LICENSE) [![Latest Release Version Number](https://img.shields.io/pypi/v/py-gutenberg)](https://pypi.org/project/py-gutenberg/releases) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/py-gutenberg)](https://pypi.org/project/py-gutenberg)\n\n## Overview\n\nThe **py-gutenberg** package is a Python library that provides methods to access the [Project Gutenberg](https://www.gutenberg.org/) library. Users can search for books based on a variety of metadata, get full texts in various formats, and retrieve metadata for books by their ID number.\n\n## Installation\n\n\u003e **_⚠️_** This package has only been tested on Python 3.7 and above. There are no plans for a Python 2 version.\n\nThe package can be installed using the pip package manager:\n\n```sh\npip install py-gutenberg\n```\n\n## Usage\n\nYou should import the module like so:\n\n```python\nfrom gutenberg import GutenbergAPI\n```\n\n\u003e The `GutenbergAPI` constructor defaults to using a public instance of the Gutendex API, hosted by me at `https://gutendex.devbranch.co`. If you are [self-hosting the API](#thanks), you can specify the IP address or URL of your instance with the `instance_url` parameter.\n\n```python\n# Uses the public instance\ngb = GutenbergAPI()\n# Uses a self-hosted instance\ngb_private = GutenbergAPI(instance_url=\"https://gutendex.yourdomain.com\")\n```\n\n### Book Lists and Searching\n\nHere's a simple example to get a list of the most recently uploaded books:\n\n```python\ngb.get_all_books()\n```\n\nOr, to get only public domain books:\n\n```python\ngb.get_public_domain_books()\n```\n\n### Individual Books\n\nTo get an individual book's metadata:\n\n```python\ngb.get_book_metadata()\n```\n\nOr, to get the full text of a book:\n\n```python\ngb.get_book_text()\n```\n\nFull usage information is available in [the documentation](https://github.com/peterrauscher/py-gutenberg/wiki/Documentation)\n\n## Thanks\n\nThis module is built on the **wonderful** but unofficial API built by [@garethbjohnson](https://github.com/garethbjohnson) known as [Gutendex](https://github.com/garethbjohnson/gutendex). By default, this library uses a public instance I'm hosting myself, but does not have the bandwidth to maintain more than a few concurrent users. Please be kind and limit your requests where possible. Additionally, if you intend to use this library in a production environment, I highly encourage you to self-host.\n\n### Read about [self-hosting the API here!](https://github.com/garethbjohnson/gutendex/wiki/Installation-Guide)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterrauscher%2Fpy-gutenberg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeterrauscher%2Fpy-gutenberg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterrauscher%2Fpy-gutenberg/lists"}