# confluence.md
Push markdown files straight to a Confluence page.
## What it does?
`confluence.md` allows you to push any markdown file to Confluence. You can create
a new page (under given parent) or update an existing one.
## How to install?
It's as easy as:
```
$ pip install confluence.md
```
## How to use it?
Markdown to Confluence
Example workflow:
### 1. Create a new page under `--parent_id`:
```
$ confluence.md --user user@name.net --token 9a8dsadsh --url https://your-domain.atlassian.net \
create --file README.md --parent_id 182371 --title "new title" --add_meta
```
### 2. The page is created and the file is decorated with metadata:
```
$ head -n 3 markdown.md
---
confluence-url: https://your-domain.atlassian.net/wiki/spaces/SP/pages/18237182/new+title
---
```
### 3. Performing an update does not require providing `--page_id` and `--url`:
```
$ confluence.md --user user@name.net --token 9a8dsadsh update --file README.md
```
Doing an update with `--page_id` and `--url` is still possible.
Consider adding useful `--add_info` option.
To create Atlassian API Token go to [api-tokens](https://id.atlassian.com/manage-profile/security/api-tokens).
**Actions:**
- `update` Updates page content based on given `page_id` or metadata in Markdown file
- `create` Creates new page under given `parent_id`
**positional arguments:**
- `{update,create}` Action to run
**optional arguments:**
- `-h`, `--help` show this help message and exit
- `--file FILE` input markdown file to process
- `--add_meta` adds metadata to .md file for easy editing
- `--add_info` adds info panel **automatic content** do not edit on top of the page
- `--add_label` `ADD_LABEL` adds label to page
- `-v`, `--verbose` verbose mode
- `-q`, `--quiet` quiet mode
**required auth parameters:**
- `-u` `USER`, `--user` `USER` Atlassian username/email
- `-t` `TOKEN`, `--token` `TOKEN` Atlassian API token
- `-l` `URL`, `--url` `URL` Atlassian instance URL
**create page parameters:**
- `--parent_id` `PARENT_ID` define parent page id while creating a new page
- `--title` `TITLE` define page title while creating a new page
- `--overwrite` force overwrite if page with this title already exists
**update page arguments:**
- `--page_id` `PAGE_ID` define (or override) page id while updating a page
Raw data
{
"_id": null,
"home_page": "https://github.com/szn/confluence.md",
"name": "confluence.md",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "markdown, confluence, md, atlassian",
"author": "Szymon Nieradka",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/05/b8/014ab0271669e8b78afc57d46009a0d0be6e2406dea1556305638754fd64/confluence.md-0.3.2.tar.gz",
"platform": null,
"description": "# confluence.md\n\nPush markdown files straight to a Confluence page.\n\n## What it does?\n\n`confluence.md` allows you to push any markdown file to Confluence. You can create\na new page (under given parent) or update an existing one.\n\n## How to install?\n\nIt's as easy as:\n\n```\n$ pip install confluence.md\n```\n\n## How to use it?\n\nMarkdown to Confluence\n\nExample workflow:\n\n### 1. Create a new page under `--parent_id`:\n```\n$ confluence.md --user user@name.net --token 9a8dsadsh --url https://your-domain.atlassian.net \\\n create --file README.md --parent_id 182371 --title \"new title\" --add_meta\n```\n\n### 2. The page is created and the file is decorated with metadata:\n```\n$ head -n 3 markdown.md\n---\nconfluence-url: https://your-domain.atlassian.net/wiki/spaces/SP/pages/18237182/new+title\n---\n```\n\n### 3. Performing an update does not require providing `--page_id` and `--url`:\n```\n$ confluence.md --user user@name.net --token 9a8dsadsh update --file README.md\n```\n\nDoing an update with `--page_id` and `--url` is still possible.\n\nConsider adding useful `--add_info` option.\n\nTo create Atlassian API Token go to [api-tokens](https://id.atlassian.com/manage-profile/security/api-tokens).\n\n**Actions:**\n\n- `update` \t\tUpdates page content based on given `page_id` or metadata in Markdown file\n- `create` \t\tCreates new page under given `parent_id`\n\n**positional arguments:**\n\n- `{update,create}` Action to run\n\n**optional arguments:**\n\n- `-h`, `--help` show this help message and exit\n- `--file FILE` input markdown file to process\n- `--add_meta` adds metadata to .md file for easy editing\n- `--add_info` adds info panel **automatic content** do not edit on top of the page\n- `--add_label` `ADD_LABEL` adds label to page\n- `-v`, `--verbose` verbose mode\n- `-q`, `--quiet` quiet mode\n\n**required auth parameters:**\n\n- `-u` `USER`, `--user` `USER` Atlassian username/email\n- `-t` `TOKEN`, `--token` `TOKEN` Atlassian API token\n- `-l` `URL`, `--url` `URL` Atlassian instance URL\n\n**create page parameters:**\n\n- `--parent_id` `PARENT_ID` define parent page id while creating a new page\n- `--title` `TITLE` define page title while creating a new page\n- `--overwrite` force overwrite if page with this title already exists\n\n**update page arguments:**\n\n- `--page_id` `PAGE_ID` define (or override) page id while updating a page\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Markdown to Confluence - upload any .md files to your Confluence cloud page",
"version": "0.3.2",
"project_urls": {
"Bug Tracker": "https://github.com/szn/confluence.md/issues",
"Homepage": "https://github.com/szn/confluence.md"
},
"split_keywords": [
"markdown",
" confluence",
" md",
" atlassian"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cc5f9cde5619aa7e2e3ced52f62eec1f95c60f09a8dd94d786262070d59e5b65",
"md5": "c0733b1cd4114c31cc4a77d0f1bda47a",
"sha256": "1afff055a0c8aeec388c4cfc93f76b1b3e1f0fa25b2ec8b6e83339d9e4d37bf3"
},
"downloads": -1,
"filename": "confluence.md-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c0733b1cd4114c31cc4a77d0f1bda47a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9320,
"upload_time": "2024-04-06T19:04:57",
"upload_time_iso_8601": "2024-04-06T19:04:57.326830Z",
"url": "https://files.pythonhosted.org/packages/cc/5f/9cde5619aa7e2e3ced52f62eec1f95c60f09a8dd94d786262070d59e5b65/confluence.md-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "05b8014ab0271669e8b78afc57d46009a0d0be6e2406dea1556305638754fd64",
"md5": "df0e367e35f3b76b29ad611f9071f57d",
"sha256": "aa8ed33d02c7aebbf855a6f80a8012c3891208bb7452e21cfec16ba111ed2043"
},
"downloads": -1,
"filename": "confluence.md-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "df0e367e35f3b76b29ad611f9071f57d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8097,
"upload_time": "2024-04-06T19:04:59",
"upload_time_iso_8601": "2024-04-06T19:04:59.619650Z",
"url": "https://files.pythonhosted.org/packages/05/b8/014ab0271669e8b78afc57d46009a0d0be6e2406dea1556305638754fd64/confluence.md-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-06 19:04:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "szn",
"github_project": "confluence.md",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "atlassian-python-api",
"specs": [
[
">=",
"3.41.3"
]
]
},
{
"name": "coloredlogs",
"specs": [
[
">=",
"15.0.1"
]
]
},
{
"name": "markdown2",
"specs": [
[
">=",
"2.4.10"
]
]
},
{
"name": "termcolor",
"specs": [
[
">=",
"2.3.0"
]
]
}
],
"lcname": "confluence.md"
}
JSON
