https://github.com/khwong-c/atlassian-doc-builder

Library to create Atlassian Document in a programmatic way.
https://github.com/khwong-c/atlassian-doc-builder

adf atlassian atlassian-confluence

Last synced: about 2 months ago
JSON representation

Library to create Atlassian Document in a programmatic way.

• Host: GitHub
• URL: https://github.com/khwong-c/atlassian-doc-builder
• Owner: khwong-c
• License: mit
• Created: 2023-01-30T00:23:50.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-07-17T10:32:19.000Z (11 months ago)
• Last Synced: 2025-12-15T09:28:53.228Z (6 months ago)
• Topics: adf, atlassian, atlassian-confluence
• Language: Python
• Homepage:
• Size: 77.1 KB
• Stars: 12
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Atlassian Document Builder

Creating Atlassian Documents in a programmatic way.

![PyPI - Downloads](https://img.shields.io/pypi/dw/atlassian-doc-builder)

![PyPI - Downloads](https://img.shields.io/pypi/dm/atlassian-doc-builder)

## Description

Provide an automatic way to generate documents and reports on the Atlassian Platform (e.g. Confluence, Jira).

Developer may automate report publication (e.g. functional verification report/requirement documents) into CI.

## Getting Started

### Dependencies

- Python3.8+

### Installing

```shell

pip install atlassian-doc-builder

```

### Creating ADF Documents

ADF Kitchen, the companion project helps developers to create ADF Documents with a graphical editor.

https://khwong-c.github.io/adf-kitchen/

## Features

- Tree-Like Document Representation

- JSON ADF Rendering and Parsing

- Reusable Template with variable filling 

- Document Validation

## Implemented Node Type

Please refer to [this document](Implemented_nodes.md).

## Roadmap

- [x] Create Base Class for ADF Object

- [x] Implement Basic Features above

- [x] Derive common classes for easy access (e.g. Text, Paragraph)

- [ ] Add short hands functions to create a document

- [x] Table Editor and Table Row Editor

- [ ] Media Display

## Examples

Please refer to [the "examples" directory](examples).

## Version History

- 0.5

  - Implement Task, Decision List and related item

  - Implement Expand (Collapsible Section) and Placeholder

  - Implement Date and more marks for text decoration

- 0.4

  - Implement Table Objects with the creation routine

  - Implement a set of Block Nodes with children

  - Index access to child nodes with `[]`. Multiple indexes supported. e.g. `doc[1,2,3]`

- 0.3

  - Support `ADFText`, `ADFLink` and a bunch of one-line classes

  - ADFObject Class Factory for quick Class Development

- 0.2

  - Add Test Suite

  - Improve ADFObject Implementations

- 0.1

  - Initial Release

## Contribution and Contact

Pull Requests and Discussion are welcome on GitHub.

## License

This project is licensed under the MIT License - see the LICENSE file for details

## Acknowledgments

This Project is inspired by:

- [pyadf project from Atlassian](https://bitbucket.org/atlassian/pyadf)