Python API

If you don’t have enough customization potential even with a custom template, the functionality of Proclamation is available through a Python API as well.

• Data model
  • Project
    • Project.fragment_filenames
    • Project.populate_sections()
    • Project.sections
  • Section
    • Section.add_fragment()
    • Section.fragment_filenames
    • Section.populate_from_directory()
  • Fragment
    • Fragment.ARBITRARY_MAX_PREFIX_LEN
    • Fragment.add_ref()
    • Fragment.parse_file()
    • Fragment.prefix
    • Fragment.ref
    • Fragment.refs
• References and reference parsing
  • Reference
    • Reference.as_tuple()
    • Reference.item_type
    • Reference.number
    • Reference.service_params
  • ReferenceParser
    • ReferenceParser.make_reference()
    • ReferenceParser.parse()
    • ReferenceParser.parse_filename()
    • ReferenceParser.split_on_dot_and_drop_ext()
• Settings
  • ProjectSettings
    • ProjectSettings.base_url
    • ProjectSettings.extra_data
    • ProjectSettings.insert_point_re
    • ProjectSettings.make_reference_parser()
    • ProjectSettings.name
    • ProjectSettings.news_filename
    • ProjectSettings.sections
    • ProjectSettings.template
  • SectionSettings
    • SectionSettings.directory
    • SectionSettings.name
    • SectionSettings.sort_by_prefix
  • Settings
    • Settings.add_project()
    • Settings.projects
  • parse_project()
  • parse_section()
  • parse_settings()
  • settings_from_json_file()
  • settings_from_json_io()
• Rendering
  • combine_changelogs()
  • generate_updated_changelog()
  • get_split_news_file()
  • render_template()
  • split_news_contents()