Metadata-Version: 2.1
Name: atlassian-doc-builder
Version: 0.4
Summary: Creating Atlassian Document in a programmatic way.
Author-email: khwong-c <kin.hin.wong.c@gmail.com>
License: MIT License
        
        Copyright (c) 2023 Kin Hin Wong
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Repository, https://github.com/khwong-c/atlassian-doc-builder
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# Atlassian Document Builder

Creating Atlassian Document in a programmatic way.

## Description

Provide an automatic way to generate documents and report on 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
```

## 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 document
- [x] Table Editor and Table Row Editor
- [ ] Media Display

## Examples

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

## Version History

- 0.4
  - Implement Table Objects with creation routine
  - Implement set of Block Nodes with children
  - Index access to child nodes with `[]`. Multiple index 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)
