The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
App-org2wp-0.003
River stage one • 1 direct dependent • 1 total dependent
/ org2wp

NAME

org2wp - Publish Org document to WordPress as blog post

VERSION

This document describes version 0.003 of org2wp (from Perl distribution App-org2wp), released on 2016-12-14.

SYNOPSIS

Usage:

 % org2wp [options] <filename>

DESCRIPTION

This is originally a quick hack because I couldn't make Lhttps://github.com/punchagan/org2blog on my Emacs installation to work after some update. org2wp uses the same format as org2blog, but instead of being an Emacs package, it is a CLI script written in Perl.

First, create ~/org2wp.conf containing the API credentials, e.g.:

 proxy=https://YOURBLOGNAME.wordpress.com/xmlrpc.php
 username=YOURUSERNAME
 password=YOURPASSWORD

You can also put multiple credentials in the configuration file using profile sections, e.g.:

 [profile=blog1]
 proxy=https://YOURBLOG1NAME.wordpress.com/xmlrpc.php
 username=YOURUSERNAME
 password=YOURPASSWORD
 
 [profile=blog2]
 proxy=https://YOURBLOG2NAME.wordpress.com/xmlrpc.php
 username=YOURUSERNAME
 password=YOURPASSWORD

and specify which profile you want using command-line option e.g. --config-profile blog1.

To create a blog post, write your Org document (e.g. in post1.org) using this format:

 #+TITLE: Blog post title
 #+CATEGORY: cat1, cat2
 #+TAGS: tag1,tag2,tag3
 
 Text of your post ...
 ...

then:

 % org2wp post1.org

this will create a draft post. To publish directly:

 % org2wp --publish post1.org

Note that this will also modify your Org file and insert this line at the top:

 #+POSTID: 1234

where 1234 is the post ID retrieved from the server when creating the post.

After the post is created, you can update using the same command:

 % org2wp post1.org

You can use --publish to publish the post, or --no-publish to revert it to draft.

To set more attributes:

 % org2wp post1.org --comment-status open \
     --extra-attr ping_status=closed --extra-attr sticky=1

OPTIONS

* marks required options.

Main options

--comment-status=s

Whether to allow comments (open) or not (closed).

Default value:

 "closed"

Valid values:

 ["open","closed"]
--extra-attr=s%

Set extra post attributes, e.g. ping_status, post_format, etc.

Each value is a name-value pair, use key=value syntax. Can be specified multiple times.

--extra-attrs-json=s

Set extra post attributes, e.g. ping_status, post_format, etc (JSON-encoded).

See --extra-attr.

--filename=s*, -f

Path to Org document to publish.

--publish

Whether to publish post or make it a draft.

Configuration options

--config-path=filename

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--no-config

Do not use any configuration file.

Environment options

--no-env

Do not read environment for default options.

Logging options

--debug

Set log level to debug (note: you also need to set LOG=1 to enable logging, or use DEBUG=1).

--log-level=s

Set log level (note: you also need to set LOG=1 to enable logging).

--quiet

Set log level to quiet (note: you also need to set LOG=1 to enable logging, or use QUIET=1).

--trace

Set log level to trace (note: you also need to set LOG=1 to enable logging, or use TRACE=1).

--verbose

Set log level to info (note: you also need to set LOG=1 to enable logging, or use VERBOSE=1).

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

 undef
--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

    [1,2,3]

Other options

--help, -h, -?

Display help message and exit.

--password=s*
--proxy=s*

Example: `https://YOURBLOGNAME.wordpress.com/xmlrpc.php`.

--username=s*
--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C org2wp org2wp

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.

tcsh

To activate tcsh completion for this script, put:

 complete org2wp 'p/*/`org2wp`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/org2wp.conf, ~/org2wp.conf, or /etc/org2wp.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

 comment_status (see --comment-status)
 extra_attrs (see --extra-attr)
 filename (see --filename)
 format (see --format)
 log_level (see --log-level)
 naked_res (see --naked-res)
 password (see --password)
 proxy (see --proxy)
 publish (see --publish)
 username (see --username)

ENVIRONMENT

ORG2WP_OPT => str

Specify additional command-line options

FILES

~/.config/org2wp.conf

~/org2wp.conf

/etc/org2wp.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-org2wp.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-org2wp.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-org2wp

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.