Atlassian Document Builder
Creating Atlassian Documents in a programmatic way.
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
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.
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 a 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 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,ADFLinkand 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:
Metadata
Release files for atlassian-doc-builder 0.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| atlassian_doc_builder-0.6.0.tar.gz | 15.3 kB | Without provenance | Details for atlassian_doc_builder-0.6.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| atlassian_doc_builder-0.6.0-py3-none-any.whl | Python 3 | none | any | Details for atlassian_doc_builder-0.6.0-py3-none-any.whl |
Total release size: 27.7 kB
Release files / atlassian_doc_builder-0.6.0.tar.gz
| Download URL | atlassian_doc_builder-0.6.0.tar.gz |
|---|---|
| Size | 15.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a00c58e540c7c7a6364acc6f4869c94f94d04bdab95dfc4b7462e484ac8523f8
|
|
BLAKE2b-256 checksum How to use checksums |
05e4b88eae35978143db99a18e6139f0bbe557f2724ef1e85da148f17a68f016
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / atlassian_doc_builder-0.6.0-py3-none-any.whl
| Download URL | atlassian_doc_builder-0.6.0-py3-none-any.whl |
|---|---|
| Size | 12.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
42b61efe54635bf055685ed23c6bbd8138b3f1bca317014c7f9bb6034b265917
|
|
BLAKE2b-256 checksum How to use checksums |
cfcb46830884bffecf32327ac10cb74c2d3bfba8fd741bcdacc7e9d1eb1bbef4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Security for atlassian-doc-builder 0.6.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.