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
10short_description: Manage packages using Scoop
11description:
12- Manage packages using Scoop.
13- If Scoop is missing from the system, the module will install it.
14options:
15  architecture:
16    description:
17    - Force Scoop to install the package of a specific process architecture.
18    type: str
19    choices: [ 32bit, 64bit ]
20    aliases: [ arch ]
21  global:
22    description:
23    - Install the app globally
24    type: bool
25    default: no
26  independent:
27    description:
28    - Don't install dependencies automatically
29    type: bool
30    default: no
31  name:
32    description:
33    - Name of the package(s) to be installed.
34    type: list
35    elements: str
36    required: yes
37  no_cache:
38    description:
39    - Don't use the download cache
40    type: bool
41    default: no
42  purge:
43    description:
44    - Remove all persistent data
45    type: bool
46    default: no
47  skip_checksum:
48    description:
49    - Skip hash validation
50    type: bool
51    default: no
52  state:
53    description:
54    - State of the package on the system.
55    - When C(absent), will ensure the package is not installed.
56    - When C(present), will ensure the package is installed.
57    type: str
58    choices: [ absent, present ]
59    default: present
60seealso:
61- module: chocolatey.chocolatey.win_chocolatey
62- name: Scoop website
63  description: More information about Scoop
64  link: https://scoop.sh
65- name: Scoop installer repository
66  description: GitHub repository for the Scoop installer
67  link: https://github.com/lukesampson/scoop
68- name: Scoop main bucket
69  description: GitHub repository for the main bucket
70  link: https://github.com/ScoopInstaller/Main
71author:
72- Jamie Magee (@JamieMagee)
73'''
74
75EXAMPLES = r'''
76- name: Install jq.
77  community.windows.win_scoop:
78    name: jq
79'''
80