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.5
- Implement Task, Decision List and related item
- Implement Expand (Collapsible Section) and Placeholder
- Implement Date and a more marks for text decoration
- 0.4
- Implement Table Objects with 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
- 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.5.tar.gz
(14.7 kB
view hashes)
Built Distribution
Close
Hashes for atlassian_doc_builder-0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2508951e9f3fb42a0e31ab26edb962d7de4dc1570bd8856ecaf41643d565729 |
|
MD5 | ad974d752282f8f7129b9ec143ba99a5 |
|
BLAKE2b-256 | 91d3103c94366f5f021d912f8dd9925f54bb0124688a7fe029b78dba006dbc02 |
Close
Hashes for atlassian_doc_builder-0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15b5d8c694a39c052300dc902b892315dc6e700374741551d3aa105046a8ba76 |
|
MD5 | 04ec3b24c70db665fd80f7cb074ac09c |
|
BLAKE2b-256 | 113fca283f2ad0169bff18ad7211218eea7cbef5f084b15a50928a69dcf4a726 |