1#!/usr/local/bin/python3.8
2# -*- coding: utf-8 -*-
3
4# Copyright: (c) 2020, Jamie Magee <jamie.magee@gmail.com>
5# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
6
7DOCUMENTATION = r'''
8---
9module: win_scoop_bucket
10version_added: 1.0.0
11short_description: Manage Scoop buckets
12description:
13- Manage Scoop buckets
14requirements:
15- git
16options:
17  name:
18    description:
19    - Name of the Scoop bucket.
20    type: str
21    required: yes
22  repo:
23    description:
24    - Git repository that contains the scoop bucket
25    type: str
26  state:
27    description:
28    - State of the Scoop bucket.
29    - When C(absent), will ensure the package is not installed.
30    - When C(present), will ensure the package is installed.
31    type: str
32    choices: [ absent, present ]
33    default: present
34seealso:
35- module: community.windows.win_scoop
36- name: Scoop website
37  description: More information about Scoop
38  link: https://scoop.sh
39- name: Scoop directory
40  description: A directory of buckets for the scoop package manager for Windows
41  link: https://rasa.github.io/scoop-directory/
42author:
43- Jamie Magee (@JamieMagee)
44'''
45
46EXAMPLES = r'''
47- name: Add the extras bucket
48  community.windows.win_scoop_bucket:
49    name: extras
50
51- name: Remove the versions bucket
52  community.windows.win_scoop_bucket:
53    name: versions
54    state: absent
55
56- name: Add a custom bucket
57  community.windows.win_scoop_bucket:
58    name: my-bucket
59    repo: https://github.com/example/my-bucket
60'''
61