Creating Atlassian Document in a programmatic way.
Project description
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
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.
Roadmap
- Create Base Class for ADF Object
- Implement Basic Features above
- Derive common classes for easy access (e.g. Text, Paragraph)
- Add short hands functions to create document
- Table Editor and Table Row Editor
- Media Display
Examples
Please refer to the "examples" directory.
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
- Support
- 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:
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
atlassian-doc-builder-0.4.tar.gz
(13.2 kB
view hashes)
Built Distribution
Close
Hashes for atlassian-doc-builder-0.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b83e21e58b6ed15f5d04bdc0a2da63871d8246762f63444e6e13280cf1a8099 |
|
MD5 | 8cc7fb78614b3a3b9a4c6fac2603b3ce |
|
BLAKE2b-256 | 5c8e746cf985b8d1faecc598290c9dc54650f255d11b09fc22e5f47b802a3099 |
Close
Hashes for atlassian_doc_builder-0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 07114140c2c04a0d4d2ba1c3865610f4fe424993166eac956621723d4a5f4da0 |
|
MD5 | 7511e6fbe8a50c158e1d2d64b4cc22a8 |
|
BLAKE2b-256 | 77d40d56ea6b78a3a4a87b51f96cdf37517519cf5132271d2c8a7dde48ddd8ca |