org2wp - Publish Org document (or heading) to WordPress as blog post
This document describes version 0.013 of org2wp (from Perl distribution App-org2wp), released on 2022-05-02.
Usage:
% org2wp [--comment-status=str] [--config-path=path|-c|--no-config|-C] [--config-profile=profile|-P] [--debug|--log-level=level|--quiet|--trace|--verbose] [--dry-run|-n] [(--exclude-heading-tag=str)+] [(--extra-attr key=s)+] [--format=name|--json] [(--include-heading-tag=str)+] [--(no)naked-res] [--no-env] [--page-result[=program]|--view-result[=program]] [--password=str] [--post-heading-level=posint] [--post-password=str] [--proxy=str] [--publish|--no-publish|--nopublish] [--schedule=date] [--username=str] [--exclude-heading-tags-json=json] [--extra-attrs-json=json] [--include-heading-tags-json=json] [-l=posint] -- <filename>
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.
org2wp
org2blog
First, create ~/org2wp.conf containing the API credentials, e.g.:
~/org2wp.conf
; use INI (IOD) format for this file proxy=https://YOURBLOGNAME.wordpress.com/xmlrpc.php username=YOURUSERNAME password=YOURPASSWORD
Note that proxy is the endpoint URL of your WordPress instance's XML-RPC server, which can be hosted on wordpress.com or on other server, including your own. It has nothing to do with HTTP/HTTPS proxy; the term "proxy" is used by the XMLRPC::Lite and SOAP::Lite Perl libraries and org2wp simply uses the same terminology.
proxy
wordpress.com
You can also put multiple credentials in the configuration file using profile sections, e.g.:
; use INI (IOD) format for this file [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.
--config-profile blog1
You can use the whole Org document file as a blog post (document mode) or a single heading as a blog post (heading mode). The default is document mode. To create a blog post, write your Org document (e.g. in post1.org) using this format:
post1.org
#+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 setting line at the top:
#+POSTID: 1234 #+POSTTIME: [2020-09-16 Wed 11:51]
where 1234 is the post ID retrieved from the server when creating the post, and post time will be set to the current local time.
After the post is created, you can update using the same command:
You can use --publish to publish the post, or --no-publish to revert it to draft.
--publish
--no-publish
To set more attributes:
% org2wp post1.org --comment-status open \ --extra-attr ping_status=closed --extra-attr sticky=1
Another example, to schedule a post in the future:
% org2wp post1.org --schedule 20301225T00:00:00
In heading mode, each heading will become a separate blog post. To enable this mode, specify --post-heading-level (-l) to 1 (or 2, or 3, ...). This will cause a level-1 (or 2, or 3, ...) heading to be assumed as an individual blog post. For example, suppose you have blog.org with this content:
--post-heading-level
-l
blog.org
* Post A :tag1:tag2:tag3: :PROPERTIES: :CATEGORY: cat1, cat2, cat3 :END: Some text... ** a heading of post A more text ... ** another heading of post A even more text ... * Post B :tag2:tag4: Some text ...
with this command:
% org2wp blog.org -l 1
there will be two blog posts to be posted because there are two level-1 headings: Post A and Post B. Post A contains level-2 headings which will become headings of the blog post. Headline tags will become blog post tags, and to specify categories you use the property CATEGORY in the PROPERTIES drawer.
Post A
Post B
CATEGORY
PROPERTIES
If, for example, you specify -l 2 instead of -l 1 then the level-2 headings will become blog posts.
-l 2
-l 1
In heading mode, you can use several options to select only certain headlines which contain (or don't contain) specified tags.
You can set the environment variable HTTP_proxy (and HTTP_proxy_user and HTTP_proxy_pass additionally). See the SOAP::Lite documentation for more details, which uses LWP::UserAgent underneath.
HTTP_proxy
HTTP_proxy_user
HTTP_proxy_pass
* marks required options.
*
Whether to allow comments (open) or not (closed).
Default value:
"closed"
Valid values:
["open","closed"]
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.
Set extra post attributes, e.g. ping_status, post_format, etc (JSON-encoded).
See --extra-attr.
--extra-attr
Path to Org document to publish.
Can also be specified as the 1st command-line argument.
Set password for posts.
Whether to publish post or make it a draft.
Equivalent to `--extra-attr post_status=published`, while `--no-publish` is equivalent to `--extra-attr post_status=draft`.
Schedule post to be published sometime in the future.
Equivalent to `--publish --extra-attr post_date=DATE`. Note that WordPress accepts date in the `YYYYMMDD"T"HH:MM:SS` format, but you specify this option in regular ISO8601 format. Also note that time is in your chosen local timezone setting.
Set path to configuration file.
Set configuration profile to use.
Do not use any configuration file.
Do not read environment for default options.
Exclude heading that has any of the specified tag(s).
Can be specified multiple times.
Exclude heading that has any of the specified tag(s) (JSON-encoded).
See --exclude-heading-tag.
--exclude-heading-tag
Only include heading that has all specified tag(s).
Only include heading that has all specified tag(s) (JSON-encoded).
See --include-heading-tag.
--include-heading-tag
Specify which heading level to be regarded as an individula blog post.
If specified, this will enable *heading mode* instead of the default *document mode*. In the document mode, the whole Org document file is regarded as a single blog post. In the *heading mode*, a heading of certain level will be regarded as a single blog post.
Shortcut for --log-level=debug.
Set log level.
Shortcut for --log-level=error.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Choose output format, e.g. json, text.
undef
Set output format to json.
When outputing as JSON, strip result envelope.
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]
Filter output through a pager.
View output using a viewer.
Run in simulation mode (also via DRY_RUN=1).
Display help message and exit.
Example: `https://YOURBLOGNAME.wordpress.com/xmlrpc.php`.
Note that `proxy` is the endpoint URL of your WordPress instance's XML-RPC server, which can be hosted on `wordpress.com` or on other server, including your own. It has nothing to do with HTTP/HTTPS proxy; the term "proxy" is used by the <pm:XMLRPC::Lite> and <pm:SOAP::Lite> Perl libraries and `org2wp` simply uses the same terminology.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
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 modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
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).
For fish and zsh, install shcompgen as described above.
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): /home/u1/.config/org2wp.conf, /home/u1/org2wp.conf, or /etc/org2wp.conf.
--config-path
All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
--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.
[profile=SOMENAME]
[SOMESECTION profile=SOMENAME]
--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.
program=NAME
[program=NAME ...]
[SOMESECTION program=NAME]
You can also 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 equals some string: [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 some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [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.
env=CONDITION
[env=SOMEVAR ...]
[SOMESECTION env=SOMEVAR ...]
[env=HOSTNAME=blink ...]
[SOMESECTION env=HOSTNAME=blink ...]
[env=HOSTNAME!=blink ...]
[SOMESECTION env=HOSTNAME!=blink ...]
[env=HOSTNAME*=server ...]
[SOMESECTION env=HOSTNAME*=server ...]
[env=HOSTNAME!*=server ...]
[SOMESECTION env=HOSTNAME!*=server ...]
To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:
-plugins
-plugins=DumpArgs
-plugins=DumpArgs@before_validate_args
[plugin=NAME ...]
[plugin=DumpArgs] -event=before_validate_args -prio=99 [plugin=Foo] -event=after_validate_args arg1=val1 arg2=val2
which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.
-plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2
List of available configuration parameters:
comment_status (see --comment-status) exclude_heading_tags (see --exclude-heading-tag) extra_attrs (see --extra-attr) filename (see --filename) format (see --format) include_heading_tags (see --include-heading-tag) log_level (see --log-level) naked_res (see --naked-res) password (see --password) post_heading_level (see --post-heading-level) post_password (see --post-password) proxy (see --proxy) publish (see --publish) schedule (see --schedule) username (see --username)
Specify additional command-line options.
/home/u1/.config/org2wp.conf
/home/u1/org2wp.conf
/etc/org2wp.conf
Please visit the project's homepage at https://metacpan.org/release/App-org2wp.
Source repository is at https://github.com/perlancar/perl-App-org2wp.
pod2wp.
html2wp.
wp-xmlrpc.
perlancar <perlancar@cpan.org>
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2022, 2020, 2019, 2017, 2016 by perlancar <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.
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.
To install App::org2wp, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::org2wp
CPAN shell
perl -MCPAN -e shell install App::org2wp
For more information on module installation, please visit the detailed CPAN module installation guide.