Metadata-Version: 2.1
Name: scrippy
Version: 1.0.6
Summary: "Scrippy framework install helper"
Home-page: https://codeberg.org/scrippy/scrippy
Author: Michael Costa, Florent Chevalier
Author-email: michael.costa@mcos.nc, florent.chevalier.nc@gmail.com
Project-URL: Bug Tracker, https://codeberg.org/scrippy/scrippy/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Environment :: Console
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: coloredlogs >=10.0
Requires-Dist: PyYAML >=5.3
Provides-Extra: dev
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: build ; extra == 'dev'
Requires-Dist: wheel >=0.37.0 ; extra == 'dev'
Requires-Dist: flake8 >=4.0.1 ; extra == 'dev'
Requires-Dist: flake8-breakpoint >=1.1.0 ; extra == 'dev'
Requires-Dist: flake8-builtins >=1.5.3 ; extra == 'dev'
Requires-Dist: flake8-print >=4.0.0 ; extra == 'dev'
Requires-Dist: flake8-return >=1.1.3 ; extra == 'dev'
Requires-Dist: pep8-naming >=0.8.2 ; extra == 'dev'
Requires-Dist: bump2version >=1.0.1 ; extra == 'dev'
Requires-Dist: setuptools >=60.9.2 ; extra == 'dev'
Requires-Dist: pypirc-chappers >=1.0.8 ; extra == 'dev'
Requires-Dist: pylint >=2.12.2 ; extra == 'dev'

![Version](https://img.shields.io/static/v1?label=version&color=informational&message=1.0.6)
![License](https://img.shields.io/static/v1?label=license&color=orange&message=MIT) ![Language](https://img.shields.io/static/v1?label=language&color=informational&message=Python)

# Scrippy installer

This is the [**Scrippy**](https://codeberg.org/scrippy) framework installer.

## Configure and install [*the Scrippy scripting framework*](https://codeberg.org/scrippy/) with default value

   - With configuration setting confirmation

      ```shell
      export PATH=${HOME}/.local/bin:${PATH}
      pip install scrippy
      scrippy install
      ```

   - Without configuration setting confirmation

      ```shell
      export PATH=${HOME}/.local/bin:${PATH}
      pip install scrippy
      scrippy install -y
      ```

## Configure and install [*the Scrippy scripting framework*](https://codeberg.org/scrippy/) interactively

  ```shell
  pip install scrippy
  scrippy install -i
  ```

## Configure and install [*the Scrippy scripting framework*](https://codeberg.org/scrippy/) from custom configuration file

  ```shell
  pip install scrippy
  scrippy install -c /path/to/config.yml
  ```

### Configuration file example

```yaml
  env:
    confdir: ~/.local/share/scrippy/conf
    datadir: ~/.local/share/scrippy/data
    histdir: ~/.local/share/scrippy/hist
    logdir: ~/.local/share/scrippy/log
    reportdir: ~/.local/share/scrippy/reports
    templatedir: ~/.local/share/scrippy/templates
    tmpdir: ~/.local/share/scrippy/tmp
  packages:
    scrippy-core: latest
    scrippy-remote: latest
    scrippy-api: latest
    scrippy-mail: latest
    scrippy-git: latest
    scrippy-template: latest
    scrippy-snmp: latest
```

## Uninstall [*the Scrippy scripting framework*](https://codeberg.org/scrippy/)

  ```shell
  scrippy uninstall
  ```

## Uninstall [*the Scrippy scripting framework*](https://codeberg.org/scrippy/) and delete all scippy directories

  ```shell
  scrippy uninstall --prune
  ```
