mirror of
https://github.com/getpelican/pelican.git
synced 2025-10-15 20:28:56 +02:00
86e11c619d
The "Getting Started" docs became overly long and unwieldy over time. This splits it into separate sections, including: * Quickstart * Installation * Writing content * Publish your site
114 lines
3.8 KiB
ReStructuredText
114 lines
3.8 KiB
ReStructuredText
.. _import:
|
|
|
|
Importing an existing site
|
|
##########################
|
|
|
|
Description
|
|
===========
|
|
|
|
``pelican-import`` is a command-line tool for converting articles from other
|
|
software to reStructuredText or Markdown. The supported import formats are:
|
|
|
|
- WordPress XML export
|
|
- Dotclear export
|
|
- Posterous API
|
|
- Tumblr API
|
|
- RSS/Atom feed
|
|
|
|
The conversion from HTML to reStructuredText or Markdown relies on `Pandoc`_.
|
|
For Dotclear, if the source posts are written with Markdown syntax, they will
|
|
not be converted (as Pelican also supports Markdown).
|
|
|
|
|
|
Dependencies
|
|
============
|
|
|
|
``pelican-import`` has some dependencies not required by the rest of Pelican:
|
|
|
|
- *BeautifulSoup4* and *lxml*, for WordPress and Dotclear import. Can be installed like
|
|
any other Python package (``pip install BeautifulSoup4 lxml``).
|
|
- *Feedparser*, for feed import (``pip install feedparser``).
|
|
- *Pandoc*, see the `Pandoc site`_ for installation instructions on your
|
|
operating system.
|
|
|
|
.. _Pandoc: http://johnmacfarlane.net/pandoc/
|
|
.. _Pandoc site: http://johnmacfarlane.net/pandoc/installing.html
|
|
|
|
|
|
Usage
|
|
=====
|
|
|
|
::
|
|
|
|
pelican-import [-h] [--wpfile] [--dotclear] [--posterous] [--tumblr] [--feed] [-o OUTPUT]
|
|
[-m MARKUP] [--dir-cat] [--dir-page] [--strip-raw] [--disable-slugs]
|
|
[-e EMAIL] [-p PASSWORD] [-b BLOGNAME]
|
|
input|api_token|api_key
|
|
|
|
Positional arguments
|
|
--------------------
|
|
|
|
input The input file to read
|
|
api_token [Posterous only] api_token can be obtained from http://posterous.com/api/
|
|
api_key [Tumblr only] api_key can be obtained from http://www.tumblr.com/oauth/apps
|
|
|
|
Optional arguments
|
|
------------------
|
|
|
|
-h, --help Show this help message and exit
|
|
--wpfile WordPress XML export (default: False)
|
|
--dotclear Dotclear export (default: False)
|
|
--posterous Posterous API (default: False)
|
|
--tumblr Tumblr API (default: False)
|
|
--feed Feed to parse (default: False)
|
|
-o OUTPUT, --output OUTPUT
|
|
Output path (default: output)
|
|
-m MARKUP, --markup MARKUP
|
|
Output markup format (supports rst & markdown)
|
|
(default: rst)
|
|
--dir-cat Put files in directories with categories name
|
|
(default: False)
|
|
--dir-page Put files recognised as pages in "pages/" sub-
|
|
directory (wordpress import only) (default: False)
|
|
--filter-author Import only post from the specified author.
|
|
--strip-raw Strip raw HTML code that can't be converted to markup
|
|
such as flash embeds or iframes (wordpress import
|
|
only) (default: False)
|
|
--disable-slugs Disable storing slugs from imported posts within
|
|
output. With this disabled, your Pelican URLs may not
|
|
be consistent with your original posts. (default:
|
|
False)
|
|
-e EMAIL, --email=EMAIL
|
|
Email used to authenticate Posterous API
|
|
-p PASSWORD, --password=PASSWORD
|
|
Password used to authenticate Posterous API
|
|
-b BLOGNAME, --blogname=BLOGNAME
|
|
Blog name used in Tumblr API
|
|
|
|
|
|
Examples
|
|
========
|
|
|
|
For WordPress::
|
|
|
|
$ pelican-import --wpfile -o ~/output ~/posts.xml
|
|
|
|
For Dotclear::
|
|
|
|
$ pelican-import --dotclear -o ~/output ~/backup.txt
|
|
|
|
for Posterous::
|
|
|
|
$ pelican-import --posterous -o ~/output --email=<email_address> --password=<password> <api_token>
|
|
|
|
For Tumblr::
|
|
|
|
$ pelican-import --tumblr -o ~/output --blogname=<blogname> <api_token>
|
|
|
|
Tests
|
|
=====
|
|
|
|
To test the module, one can use sample files:
|
|
|
|
- for WordPress: http://wpcandy.com/made/the-sample-post-collection
|
|
- for Dotclear: http://themes.dotaddict.org/files/public/downloads/lorem-backup.txt
|