Skip to content

samuel-emrys/gwbridge

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Build

GitHub Wordpress Bridge

gwbridge is a program that manages the continuous deployment of markdown content on GitHub to a WordPress blog.

External Dependencies

  • Pandoc 2.9 or later

See Installing pandoc for instructions on installing this for your target platform.

Installation

gwbridge is available for installation using pip or pipx as follows:

$ pipx install git+https://github.com/samuel-emrys/gwbridge.git
$ pip install git+https://github.com/samuel-emrys/gwbridge.git

Of these, the pipx method is recommended. This will make the command available in the global environment whilst maintaining a virtual environment for the required python dependencies. See the pipx documentation for installation instructions.

Usage

gwbridge has three functions:

  1. Initialisation of a repository
  2. Obtaining authentication keys
  3. Publishing a post to a Wordpress blog

Initialisation

Navigate to your repository and initialise it as follows:

$ gwbridge init
Enter the base URL of the wordpress blog to update (required): https://www.example.com/wp-json
Enter the version of the WPI you wish to use [wp/v2]:
Enter the name of the file to publish [README.md]:
Configuration file created at .deploy/config.json
Metadata file created at .deploy/metadata.json

This configures the file README.md to be pushed as a new blog post to the Wordpress site https://www.example.com. As mentioned, this will create a configuration file in .deploy/config.json, and initialise a file containing the post metadata in .deploy/metadata.json. Edit these files as you desire to configure the way your post is created. The available fields are detailed in the Wordpress REST API Documentation.

Authentication

Authentication requires the Wordpress server to have the WordPress REST API - OAuth 1.0a Server plugin installed. Once installed, navigate to Users > Applications and Edit the application you've created. This page has two credential fields, Client Key, and Client Secret. You'll need to use these values to generate the appropriate authentication keys to allow gwbridge to create a post on your site. If you've already initialised a repository, you can run:

$ gwbridge authenticate --client-key $WP_CLIENT_KEY --client-secret $WP_CLIENT_SECRET
Authenticate at the following URL to obtain a verification token: https://www.example.com/oauth1/authorize?oauth_token=j53H324FIjuBNvZJSYA5zLdR
Enter the verification token: sjBsFr5dPS9uPNuhIydLNrS9
Client key               HZAajT8gOtI8
Client secret            wZl5Y6GnY9q77ujTfblbtzkL6QuMN0bbcBbcLg4wHXPRnSgK
Resource owner key       ZFM4an7hJG45ajFrXlLGd7dM
Resource owner secret    3CgBHAkHclw4SgErQYrq6WrB1d04BgaQFlqdjnAsBWLIafOI

Otherwise, you'll need to pass the --base-url and --api-version flags to indicate the site you want to authenticate to:

$ gwbridge authenticate --client-key $WP_CLIENT_KEY --client-secret $WP_CLIENT_SECRET --base-url https://www.example.com/wp-json --api-version wp/v2

Navigate to the prompted link, and sign in to your desired Wordpress account. It must have the Editor role or higher, however, so that it can create and update posts. This will present you with a token. Copy and paste the token to the command prompt. Pressing Enter will then provide you with Resource Owner Key and Resource Owner Secret credentials. These will be used to publish your post.

Publish

To publish, make sure you have your desired values in .deploy/metadata, and then execute the following command using the credentials obtained from the authentication command.

$ gwbridge publish --client-key $WP_CLIENT_KEY --client-secret $WP_CLIENT_SECRET --resource-owner-key $WP_RESOURCE_OWNER_KEY --resource-owner-secret $WP_RESOURCE_OWNER_SECRET
It doesn't look like this has been published yet. Creating a new post!
Setting things up...
Pushing new content...
Done! The updated post is available at https://www.example.com/?p=173

NOTE: The post title and content fields will be automatically populated from the markdown file and shouldn't be populated in the metadata configuration. For new posts, the id field should be left blank. This will be automatically updated after the post is first published to Wordpress to the new post id.

About

Publishes markdown content to a Wordpress blog

Resources

License

Stars

Watchers

Forks

Packages

No packages published