{"id":23198,"library":"adf-lib","title":"ADF Lib","description":"A Python library for creating and manipulating ADF (Atlassian Document Format) documents. Current version 0.2.1, requires Python >=3.8. Early stage development with infrequent releases.","status":"active","version":"0.2.1","language":"python","source_language":"en","source_url":"https://github.com/lakmal98/adf-lib","tags":["adf","atlassian","document-format"],"install":[{"cmd":"pip install adf-lib","lang":"bash","label":"Install from PyPI"}],"dependencies":[],"imports":[{"note":"Common mistake: using 'Document' instead of 'ADFDocument'","wrong":"from adf_lib import Document","symbol":"ADFDocument","correct":"from adf_lib import ADFDocument"},{"note":"Wrong class name: use ADFParagraph","wrong":"from adf_lib import Paragraph","symbol":"ADFParagraph","correct":"from adf_lib import ADFParagraph"}],"quickstart":{"code":"from adf_lib import ADFDocument, ADFParagraph\n\ndoc = ADFDocument()\np = ADFParagraph(text='Hello, world!')\ndoc.add(p)\nprint(doc.to_dict())","lang":"python","description":"Create an ADF document with a paragraph and output the dictionary representation."},"warnings":[{"fix":"Use the full prefixed class names: ADFDocument, ADFParagraph, etc.","message":"All classes are prefixed with 'ADF'. Using names like 'Document' or 'Paragraph' will cause ImportError.","severity":"gotcha","affected_versions":">=0.1.0"},{"fix":"Pin the exact version in requirements and test upgrades thoroughly.","message":"The library is in early alpha stage (v0.2.1). APIs may break without notice.","severity":"gotcha","affected_versions":">=0.1.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run 'pip install adf-lib' and then use 'from adf_lib import ...'.","cause":"You are trying to import 'adf_lib' as a module, but the correct import is 'adf_lib' (with underscore).","error":"ModuleNotFoundError: No module named 'adf_lib'"},{"fix":"Use 'from adf_lib import ADFDocument'.","cause":"The library uses prefixed class names (e.g., 'ADFDocument'), not plain 'Document'.","error":"ImportError: cannot import name 'Document' from 'adf_lib'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}