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
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
Examples
WIP
Version History
- 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
Built Distribution
Close
Hashes for atlassian-doc-builder-0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7a4494ca7e30a48688fcc726b75f3f4a827801319aa96607ba34cfad8fc6ba80 |
|
MD5 | ffc548d11a4195d34622d9b679a11cf6 |
|
BLAKE2b-256 | 1a799f51172720553a9518874204d2978121fa8fb1dd62db9d76266c91cb60be |
Close
Hashes for atlassian_doc_builder-0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fab990c21a3040aba3fecf18c08f1558e5d3c84bd11cd12ef835eb7b058b7ea2 |
|
MD5 | 0d20b4bfa3262b3535874de6ff887ee7 |
|
BLAKE2b-256 | 99482ffcff4cada20aacfbbcc27cb90d5f8fef612122aa06135283600ed5db55 |