html2wp - Publish HTML document to WordPress as blog post
This document describes version 0.001 of html2wp (from Perl distribution App-html2wp), released on 2017-06-16.
Usage:
% html2wp [options] <filename>
To use this program, first create ~/html2wp.conf containing the API credentials, e.g.:
~/html2wp.conf
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.
--config-profile blog1
then:
% html2wp post1.html
(You should provide blog post title in your HTML in the <title> or <meta name="title" content="...">. You can also put categories in <meta name="categories" content="cat1,cat2,..."> and tags in <meta name="tags" content="tag1,tag2,...">.)
<title>
<meta name="title" content="...">
<meta name="categories" content="cat1,cat2,...">
<meta name="tags" content="tag1,tag2,...">
The above command will create a draft post. To publish directly:
% html2wp post1.html ... --publish
Note that this will also modify your HTML file and insert this element at the beginning of the document:
<meta name="postid" content="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:
You can use --publish to publish the post, or --no-publish to revert it to draft.
--publish
--no-publish
To set more attributes:
% html2wp post1.html ... --comment-status open \ --extra-attr ping_status=closed --extra-attr sticky=1
Another example, to schedule a post in the future:
% html2wp post1.html --schedule 20301225T00:00:00
* 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 HTML document to publish.
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.
Can be specified multiple times.
Set configuration profile to use.
Do not use any configuration file.
Do not read environment for default options.
Set log level to debug (note: you also need to set LOG=1 to enable logging, or use DEBUG=1).
Set log level (note: you also need to set LOG=1 to enable logging).
Set log level to quiet (note: you also need to set LOG=1 to enable logging, or use QUIET=1).
Set log level to trace (note: you also need to set LOG=1 to enable logging, or use TRACE=1).
Set log level to info (note: you also need to set LOG=1 to enable logging, or use VERBOSE=1).
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]
Display help message and exit.
Example: `https://YOURBLOGNAME.wordpress.com/xmlrpc.php`.
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 html2wp html2wp
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 immediately have tab completion.
To activate tcsh completion for this script, put:
complete html2wp 'p/*/`html2wp`/'
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): ~/.config/html2wp.conf, ~/html2wp.conf, or /etc/html2wp.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]
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.
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 ...]
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) schedule (see --schedule) username (see --username)
Specify additional command-line options.
~/.config/html2wp.conf
/etc/html2wp.conf
Please visit the project's homepage at https://metacpan.org/release/App-html2wp.
Source repository is at https://github.com/perlancar/perl-App-html2wp.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-html2wp
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.
org2wp.
pod2wp.
wp-xmlrpc.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2017 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.
To install App::html2wp, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::html2wp
CPAN shell
perl -MCPAN -e shell install App::html2wp
For more information on module installation, please visit the detailed CPAN module installation guide.