def publish(obj, path, ext=None, linkify=None, index=None, **kwargs):
"""Publish an object to a given format.
The function can be called in two ways:
1. document or item-like object + output file path
2. tree-like object + output directory path
:param obj: (1) Item, list of Items, Document or (2) Tree
:param path: (1) output file path or (2) output directory path
:param ext: file extension to override output extension
:param linkify: turn links into hyperlinks (for Markdown or HTML)
:param index: create an index.html (for HTML)
:raises: :class:`doorstop.common.DoorstopError` for unknown file formats
:return: output location if files created, else None
"""
# Determine the output format
ext = ext or os.path.splitext(path)[-1] or '.html'
check(ext)
if linkify is None:
linkify = is_tree(obj) and ext == '.html'
if index is None:
index = is_tree(obj) and ext == '.html'
# Publish documents
count = 0
for obj2, path2 in iter_documents(obj, path, ext):
count += 1
# Publish content to the specified path
common.create_dirname(path2)
log.info("publishing to {}...".format(path2))
lines = publish_lines(obj2, ext, linkify=linkify, **kwargs)
common.write_lines(lines, path2)
# Create index
if index and count:
_index(path, tree=obj if is_tree(obj) else None)
# Return the published path
if count:
msg = "published to {} file{}".format(count, 's' if count > 1 else '')
log.info(msg)
return path
else:
log.warning("nothing to publish")
return None
""" copy the CSS file to the output directory
so we can reference it instead of embedding it
"""
if ext == '.html':
shutil.copy(CSS, path)
def publish(obj, path, ext=None, linkify=None, index=None, **kwargs):
"""Publish an object to a given format.
The function can be called in two ways:
1. document or item-like object + output file path
2. tree-like object + output directory path
:param obj: (1) Item, list of Items, Document or (2) Tree
:param path: (1) output file path or (2) output directory path
:param ext: file extension to override output extension
:param linkify: turn links into hyperlinks (for Markdown or HTML)
:param index: create an index.html (for HTML)
:raises: :class:`doorstop.common.DoorstopError` for unknown file formats
:return: output location if files created, else None
"""
# Determine the output format
ext = ext or os.path.splitext(path)[-1] or '.html'
check(ext)
if linkify is None:
linkify = is_tree(obj) and ext in ['.html', '.md']
if index is None:
index = is_tree(obj) and ext == '.html'
# Publish documents
count = 0
for obj2, path2 in iter_documents(obj, path, ext):
count += 1
# Publish content to the specified path
common.create_dirname(path2)
log.info("publishing to {}...".format(path2))
lines = publish_lines(obj2, ext, linkify=linkify, **kwargs)
common.write_lines(lines, path2)
if obj2.assets:
src = obj2.assets
dst = os.path.join(os.path.dirname(path2), obj2.ASSETS)
common.copy(src, dst)
# Create index
if index and count:
_index(path, tree=obj if is_tree(obj) else None)
# Return the published path
if count:
msg = "published to {} file{}".format(count, 's' if count > 1 else '')
log.info(msg)
return path
else:
log.warning("nothing to publish")
return None
def _create(path, name): # pragma: no cover (integration test)
"""Create a new file for the object.
:param path: path to new file
:param name: humanized name for this file
:raises: :class:`~doorstop.common.DoorstopError` if the file
already exists
"""
if os.path.exists(path):
raise DoorstopError("{} already exists: {}".format(name, path))
common.create_dirname(path)
common.touch(path)
def export(obj, path, ext=None, **kwargs):
"""Export an object to a given format.
The function can be called in two ways:
1. document or item-like object + output file path
2. tree-like object + output directory path
:param obj: (1) Item, list of Items, Document or (2) Tree
:param path: (1) output file path or (2) output directory path
:param ext: file extension to override output extension
:raises: :class:`doorstop.common.DoorstopError` for unknown file formats
:return: output location if files created, else None
"""
# Determine the output format
ext = ext or os.path.splitext(path)[-1] or '.csv'
check(ext)
# Export documents
count = 0
for obj2, path2 in iter_documents(obj, path, ext):
count += 1
# Export content to the specified path
common.create_dirname(path2)
log.info("exporting to {}...".format(path2))
if ext in FORMAT_LINES:
lines = export_lines(obj2, ext, **kwargs)
common.write_lines(lines, path2)
else:
export_file(obj2, path2, ext, **kwargs)
# Return the exported path
if count:
msg = "exported to {} file{}".format(count, 's' if count > 1 else '')
log.info(msg)
return path
else:
log.warning("nothing to export")
return None
def export(obj, path, ext=None, **kwargs):
"""Export an object to a given format.
The function can be called in two ways:
1. document or item-like object + output file path
2. tree-like object + output directory path
:param obj: (1) Item, list of Items, Document or (2) Tree
:param path: (1) output file path or (2) output directory path
:param ext: file extension to override output extension
:raises: :class:`doorstop.common.DoorstopError` for unknown file formats
:return: output location if files created, else None
"""
# Determine the output format
ext = ext or os.path.splitext(path)[-1] or '.csv'
check(ext)
# Export documents
count = 0
for obj2, path2 in iter_documents(obj, path, ext):
count += 1
# Export content to the specified path
common.create_dirname(path2)
log.info("exporting to {}...".format(path2))
if ext in FORMAT_LINES:
lines = export_lines(obj2, ext, **kwargs)
common.write_lines(lines, path2)
else:
export_file(obj2, path2, ext, **kwargs)
# Return the exported path
if count:
msg = "exported to {} file{}".format(count, 's' if count > 1 else '')
log.info(msg)
return path
else:
log.warning("nothing to export")
return None
