Welcome to pytablewriter’s documentation!

Table of Contents

• 1. pytablewriter
  • 1.1. Summary
  • 1.2. Features
• 2. Installation
  • 2.1. Installation: pip
  • 2.2. Installation: conda
  • 2.3. Installation: apt
• 3. Dependencies
  • 3.1. Optional dependencies
• 4. Examples
  • 4.1. Basic usage
  • 4.2. Write table(s) with a specific format
    • 4.2.1. Text formats
      • 4.2.1.1. CSV
      • 4.2.1.2. LaTeX
      • 4.2.1.3. LTSV
      • 4.2.1.4. HTML
      • 4.2.1.5. JSON
      • 4.2.1.6. Markdown
      • 4.2.1.7. MediaWiki
      • 4.2.1.8. reStructuredText
      • 4.2.1.9. Source Code
      • 4.2.1.10. Space Aligned
      • 4.2.1.11. TOML
      • 4.2.1.12. Unicode
      • 4.2.1.13. YAML
    • 4.2.2. Binary formats
      • 4.2.2.1. Spread Sheets
      • 4.2.2.2. SQLite
    • 4.2.3. Elasticsearch
  • 4.3. Configure output
    • 4.3.1. Configure Output Stream
    • 4.3.2. Get Rendered Tabular Text as str
  • 4.4. Tabular Data Sources
    • 4.4.1. Using CSV as a tabular data source
      • 4.4.1.1. from CSV text
      • 4.4.1.2. from a CSV file
    • 4.4.2. from space-separated values (SSV) text
    • 4.4.3. Using pandas DataFrame as a tabular data source
  • 4.5. Specify Cell Styles For Each Column
  • 4.6. Specify theme
  • 4.7. Using Multi-Byte Characters
    • 4.7.1. Write a table with multi-byte characters
  • 4.8. Configure Type Hints
    • 4.8.1. Type Hint: JavaScript Code
    • 4.8.2. Type Hint: Python Code
  • 4.9. Jupyter Notebook Support
  • 4.10. Multiprocessing
• 5. Reference
  • 5.1. Table Writer Classes
    • 5.1.1. Text formats
      • 5.1.1.1. CSV table writer classes
      • 5.1.1.2. LTSV writer
      • 5.1.1.3. LaTeX writer classes
      • 5.1.1.4. Markup language writer classes
      • 5.1.1.5. JSON writer class
      • 5.1.1.6. Line-delimited JSON(LDJSON) writer class
      • 5.1.1.7. Source code writer classes
      • 5.1.1.8. reStructuredText writer classes
      • 5.1.1.9. Space aligned table writer
      • 5.1.1.10. TOML table writer class
      • 5.1.1.11. YAML table writer class
      • 5.1.1.12. Unicode table writer classes
      • 5.1.1.13. Borderless table writer class
      • 5.1.1.14. CSS table writer class
    • 5.1.2. Binary formats
      • 5.1.2.1. Excel writer classes
      • 5.1.2.2. Pandas DataFrame writer class
      • 5.1.2.3. SQLite writer class
    • 5.1.3. Application specific formats
      • 5.1.3.1. Elasticsearch writer
    • 5.1.4. Base writer classes
      • 5.1.4.1. Abstract classes
      • 5.1.4.2. Base writer classes of text formats
      • 5.1.4.3. Base writer classes of binary formats
  • 5.2. Table Writer Factory
    • TableWriterFactory
      • TableWriterFactory.create_from_file_extension()
      • TableWriterFactory.create_from_format_name()
      • TableWriterFactory.get_extensions()
      • TableWriterFactory.get_format_names()
  • 5.3. Table Format
    • FormatAttr
      • FormatAttr.API
      • FormatAttr.BIN
      • FormatAttr.FILE
      • FormatAttr.SOURCECODE
      • FormatAttr.TEXT
    • TableFormat
      • TableFormat.find_all_attr()
      • TableFormat.from_name()
      • TableFormat.file_extensions
      • TableFormat.find_all_attr()
      • TableFormat.format_attribute
      • TableFormat.from_file_extension()
      • TableFormat.from_name()
      • TableFormat.names
      • TableFormat.writer_class
  • 5.4. Style
    • Style
      • Style.update()
    • Align
      • Align.AUTO
      • Align.CENTER
      • Align.LEFT
      • Align.RIGHT
      • Align.align_code
      • Align.align_string
    • DecorationLine
      • DecorationLine.LINE_THROUGH
      • DecorationLine.NONE
      • DecorationLine.STRIKE
      • DecorationLine.UNDERLINE
    • FontWeight
      • FontWeight.BOLD
      • FontWeight.NORMAL
    • FontSize
      • FontSize.LARGE
      • FontSize.MEDIUM
      • FontSize.NONE
      • FontSize.SMALL
      • FontSize.TINY
    • FontStyle
      • FontStyle.ITALIC
      • FontStyle.NORMAL
      • FontStyle.TYPEWRITER
    • ThousandSeparator
      • ThousandSeparator.COMMA
      • ThousandSeparator.NONE
      • ThousandSeparator.SPACE
      • ThousandSeparator.UNDERSCORE
    • VerticalAlign
      • VerticalAlign.BASELINE
      • VerticalAlign.BOTTOM
      • VerticalAlign.MIDDLE
      • VerticalAlign.TOP
      • VerticalAlign.align_code
      • VerticalAlign.align_str
    • Cell
      • Cell.col
      • Cell.default_style
      • Cell.is_header_row()
      • Cell.row
      • Cell.value
  • 5.5. Functions
    • dumps_tabledata()
  • 5.6. Theme
    • StyleFilterFunc
      • StyleFilterFunc.__call__()
    • ColSeparatorStyleFilterFunc
      • ColSeparatorStyleFilterFunc.__call__()
    • CheckStyleFilterKeywordArgsFunc
      • CheckStyleFilterKeywordArgsFunc.__call__()
    • Theme
      • Theme.check_style_filter_kwargs
      • Theme.col_separator_style_filter
      • Theme.style_filter
  • 5.7. Errors
    • EmptyTableNameError
    • EmptyValueError
    • EmptyTableDataError
    • WriterNotFoundError
• 6. Changelog
• 7. Projects using pytablewriter
• 8. Related Projects
• 9. Sponsors
• 10. Indices and tables
• 11. Links

Indices and tables

• Index