CONTRIBUTING.md

Contributing

Prerequisites

1. Install pyenv
2. Install Python 3.8+

   $ pyenv install 3.8.13

3. Install Poetry

Setup

1. Clone the project.

   $ git clone git@github.com:Bellese/confluence-utils.git

2. From the project root, set the project Python version

   $ cd confluence-utils
   $ poetry env use python

3. Install dependencies and pre-commit hooks

   $ poetry install && poetry run pre-commit install && poetry run pre-commit install --hook-type commit-msg

4. (Optional) Open in VS Code

   $ poetry shell
   $ code .

Testing Locally

$ poetry run confluence --help
Usage: confluence [OPTIONS] COMMAND [ARGS]...

  Commandline interface for Confluence.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  publish

$ poetry run confluence publish --help
Usage: confluence publish [OPTIONS] PATH

Options:
  --url TEXT    The URL to the Confluence API. Optionally set with
                CONFLUENCE_URL.  [required]
  --space TEXT  Confluence API Space. Optionally set with CONFLUENCE_SPACE.
                [required]
  --token TEXT  Confluence API Token. Optionally set with CONFLUENCE_TOKEN.
                [required]
  --help        Show this message and exit.