Metadata-Version: 2.4
Name: edwh-ghost
Version: 0.2.2
Dynamic: Requires-Dist
Dynamic: Provides-Extra
Summary: Python client for Ghost API v3/v4/v5/v6
Project-URL: Homepage, https://github.com/educationwarehouse/edwh-ghost
Author-email: Remco Boerma <remco.b@educationwarehouse.nl>, Robin van der NOord <robin.vdn@educationwarehouse.nl>
License: MIT
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# EDWH Ghost Client

This Client is compatible with v3, v4, v5 and v6 of the Ghost CMS [Admin](https://ghost.org/docs/admin-api)
and [Content](https://ghost.org/docs/content-api/) API's.

### Installation

```bash
pip install edwh-ghost
```

### Usage

The `GhostAdmin` class can be instantiated as follows:

```python
from ghost import GhostAdmin
from dotenv import dotenv_values

config = dotenv_values(".env")

# .env can be used, but config values can also be simply hardcoded
ga = GhostAdmin(
    config["GHOST_SITE"],
    adminAPIKey=config["GHOST_ADMIN_KEY"],
    contentAPIKey=config["GHOST_CONTENT_KEY"],
    api_version="v4",  # works like a train
)
print(ga.site())
```

If no admin API key is available, the `GhostContent` class can be used, which has read-only access to public endpoints.

After creating a `GhostClient` instance, the different Resources can be used:

```python
from ghost.resources import *

posts: PostResource = ga.posts

# READ
multiple = posts(limit=5)  # Ghost Result Set
# alias for
posts.get(limit=5)  # Ghost Result Set

some_post = posts.get("some_id")  # Ghost Result 

for post in posts.paginate():
    # iterate without limit
    print(post)  # Ghost Result

# UPDATE
some_post.update({...})  # response dict  
# alias:
posts.update("some_id", {...})  # response dict  
# bulk:
multiple.update({...})  # response dict 

# DELETE
some_post.delete()  # bool of success
# alias:
posts.delete("some_id")  # bool of success
# bulk:
multiple.delete()  # list of bools of success

# CREATE
# one:
posts.create(title="...", etc="...")  # response dict
# bulk:
posts.create({...}, {...})  # list of response dicts

# some resources are read only:
authors: AuthorResource = ga.authors

authors()  # Ghost Result Set

authors.delete()  # error
```

# Available Resources:

| Resource Class[^1] | Ghost Path | Method[^2]                                     | Related Tests                                               | Admin?  | Content? |
|--------------------|------------|------------------------------------------------|-------------------------------------------------------------|---------|----------|
| Posts              | /posts     | ghost.posts(), ghost.post()                    | test_1_posts, test_10_ghost_content, test_11_ghost_paginate | &check; | &check;  |
| Pages              | /pages     | ghost.pages(), ghost.page()                    | test_2_pages                                                | &check; | &check;  |
| Authors            | /authors   | ghost.authors(), ghost.author()                | test_4_authors                                              | ~[^3]   | &check;  |
| Tags               | /tags      | ghost.tags(), ghost.tag()                      | test_3_tags                                                 | &check; | &check;  |
| Members            | /members   | ghost.members(), ghost.member()                | test_9_members                                              | &check; | &cross;  |
| Images             | /images    | ghost.images.upload()                          | test_6_images                                               | &check; | &cross;  |
| Themes             | /themes    | ghost.themes.upload(), ghost.themes.activate() | test_7_themes                                               | &check; | &cross;  |
| Site               | /site      | ghost.site()                                   | test_8_site_and_settings                                    | &check; | &cross;  |
| Settings           | /settings  | ghost.settings()                               | test_8_site_and_settings                                    | ~[^3]   | &check;  |
| Users              | /users     | ghost.user(), ghost.users()                    | test_12_users, test_13_users_content                        | &check; | &cross;  |

[^1]: these classes live in `ghost.resources`
[^2]: where `ghost` is an instance of a `GhostClient` subclass (`GhostContent` or `GhostAdmin`)
[^3]: Content APIs are also accessible through the `GhostAdmin` client, they are however read-only

## Unavailable Resources:

| Resource Name | Ghost Path | Admin?  | Content? | Reason         |
|---------------|------------|---------|----------|----------------|
| Tiers         | /tiers     | &check; | &check;  | Testing Failed | <!-- test_5_tiers -->
| Offers        | /offers    | &check; | &cross;  | Testing Failed |
| Webhooks      | /webhooks  | &check; | &cross;  | TODO           |
