# conflupy
A Python library for Atlassian Confluence REST API
> Version with 1.0.x ~ 1.2.x are for distribution tests and have bugs. Please use conflupy >= 1.3.0
## Requirements
- Python >= 3.9
- Atlassian Confluence ([REST API docs](https://docs.atlassian.com/ConfluenceServer/rest/7.19.0))
- This library is tested in `Atlassian Confluence 7.19.0`
- [Confluence REST API examples](https://developer.atlassian.com/server/confluence/confluence-rest-api-examples)
- [Confluence Storage Format](https://confluence.atlassian.com/conf719/confluence-storage-format-1157466554.html)
## Installation
```sh
pip install conflupy
```
## Usage
```python
from confluence import Confluence
# Initialize Confluence
confluence = Confluence(base_url: 'https://confluence.example.com', account: (USER_ID, USER_PW))
# Get Pages
pages = confluence.get_pages(space_key='TEST')
print('Pages :', pages)
# Get Specific Page
page = confluence.get_content(content_id='1349141')
print('Page :', page)
# Create a new Page
body = '<h1>Hello</h1><br /><p>This is a page created with REST API</p>'
new_page = create_page(space_key='TEST', title='Test Page', body=body)
print('New Page :', new_page)
```
## Build & Deploy (PyPi)
```sh
# Build
pip install build
python -m build
# whl file & archived src(tar.gz) file will be generated.
# Deploy
pip install twine
python -m twine upload dist/*
# package will be uploaded to PyPi registry
# https://pypi.org/project/conflupy
```
> However, this project use GitHub Actions workflow to automatically publish the package to PyPI when a tag pushed.
## To Do
- [ ] Unittest
## Authors
- [Daeyeol Ryu](https://yoobato.com)
## License
- [Apache License 2.0](./LICENSE.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/yoobato/conflupy",
"name": "conflupy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "atlassian,confluence",
"author": "Daeyeol Ryu",
"author_email": "yoobato@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7f/f8/d08f4fdefd23236d754595250391b432d9458f2a289f9a1802268f627ae8/conflupy-1.3.0.tar.gz",
"platform": null,
"description": "# conflupy\n\n\n\n\nA Python library for Atlassian Confluence REST API\n> Version with 1.0.x ~ 1.2.x are for distribution tests and have bugs. Please use conflupy >= 1.3.0\n\n## Requirements\n- Python >= 3.9\n- Atlassian Confluence ([REST API docs](https://docs.atlassian.com/ConfluenceServer/rest/7.19.0))\n - This library is tested in `Atlassian Confluence 7.19.0`\n - [Confluence REST API examples](https://developer.atlassian.com/server/confluence/confluence-rest-api-examples)\n - [Confluence Storage Format](https://confluence.atlassian.com/conf719/confluence-storage-format-1157466554.html)\n\n## Installation\n```sh\npip install conflupy\n```\n\n## Usage\n```python\nfrom confluence import Confluence\n\n# Initialize Confluence\nconfluence = Confluence(base_url: 'https://confluence.example.com', account: (USER_ID, USER_PW))\n\n# Get Pages\npages = confluence.get_pages(space_key='TEST')\nprint('Pages :', pages)\n\n# Get Specific Page\npage = confluence.get_content(content_id='1349141')\nprint('Page :', page)\n\n# Create a new Page\nbody = '<h1>Hello</h1><br /><p>This is a page created with REST API</p>'\nnew_page = create_page(space_key='TEST', title='Test Page', body=body)\nprint('New Page :', new_page)\n```\n\n## Build & Deploy (PyPi)\n```sh\n# Build\npip install build\npython -m build\n# whl file & archived src(tar.gz) file will be generated.\n\n# Deploy\npip install twine\npython -m twine upload dist/*\n# package will be uploaded to PyPi registry\n# https://pypi.org/project/conflupy\n```\n> However, this project use GitHub Actions workflow to automatically publish the package to PyPI when a tag pushed.\n\n## To Do\n- [ ] Unittest\n\n## Authors\n- [Daeyeol Ryu](https://yoobato.com)\n\n## License\n- [Apache License 2.0](./LICENSE.md)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Python library for Atlassian Confluence REST API",
"version": "1.3.0",
"split_keywords": [
"atlassian",
"confluence"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fdafeec5b822710450a6ca316f1549a90c8b32e4958281795468fc7b119f17cd",
"md5": "3bb40c4f25e561b16f9d48d76aae966e",
"sha256": "48defbfe1602dedfa165c6d8d6867fe0de5508c8bc147b20138ffb49856d4155"
},
"downloads": -1,
"filename": "conflupy-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3bb40c4f25e561b16f9d48d76aae966e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 11806,
"upload_time": "2023-03-13T10:49:13",
"upload_time_iso_8601": "2023-03-13T10:49:13.950102Z",
"url": "https://files.pythonhosted.org/packages/fd/af/eec5b822710450a6ca316f1549a90c8b32e4958281795468fc7b119f17cd/conflupy-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7ff8d08f4fdefd23236d754595250391b432d9458f2a289f9a1802268f627ae8",
"md5": "ac7d03212cf5e3aacb5ca0dde79828d7",
"sha256": "e20afc7c17a3dddb1e1a4a9443ccb59318c3cb0c587446b26517defb88ecbc12"
},
"downloads": -1,
"filename": "conflupy-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "ac7d03212cf5e3aacb5ca0dde79828d7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8385,
"upload_time": "2023-03-13T10:49:16",
"upload_time_iso_8601": "2023-03-13T10:49:16.324373Z",
"url": "https://files.pythonhosted.org/packages/7f/f8/d08f4fdefd23236d754595250391b432d9458f2a289f9a1802268f627ae8/conflupy-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-13 10:49:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "yoobato",
"github_project": "conflupy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "conflupy"
}
JSON
