Metadata-Version: 2.1
Name: niagara
Version: 0.0.0.2
Summary: A simple ricing tool for Linux systems.
Home-page: https://github.com/ArtixLabs/Niagara
Author: kavulox
License: AGPL-3.0
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE

<div align="center">

<p>
    <a href="https://github.com/ArtixLabs/Niagara/releases/latest">
      <img alt="Latest release" src="https://img.shields.io/github/v/release/ArtixLabs/Niagara?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41" />
    </a>
    <a href="https://github.com/ArtixLabs/Niagara/pulse">
      <img alt="Last commit" src="https://img.shields.io/github/last-commit/ArtixLabs/Niagara?style=for-the-badge&logo=starship&color=8bd5ca&logoColor=D9E0EE&labelColor=302D41"/>
    </a>
    <a href="https://github.com/ArtixLabs/Niagara/blob/master/LICENSE">
      <img alt="License" src="https://img.shields.io/github/license/ArtixLabs/Niagara?style=for-the-badge&logo=starship&color=ee999f&logoColor=D9E0EE&labelColor=302D41" />
    </a>
    <a href="https://github.com/ArtixLabs/Niagara/stargazers">
      <img alt="Stars" src="https://img.shields.io/github/stars/ArtixLabs/Niagara?style=for-the-badge&logo=starship&color=c69ff5&logoColor=D9E0EE&labelColor=302D41" />
    </a>
    <a href="https://github.com/ArtixLabs/Niagara/issues">
      <img alt="Issues" src="https://img.shields.io/github/issues/ArtixLabs/Niagara?style=for-the-badge&logo=bilibili&color=F5E0DC&logoColor=D9E0EE&labelColor=302D41" />
    </a>
</div>

## Niagara

Niagara is a ricing tool made for Linux systems. It aims to be a universal tool that can be used on multiple distributions, as it does not rely on a singular package manager. Niagara manages configs by taking a JSON file that contains some fields such as `packages`, `dotfile`, `wallpaper`, etc. 

### How does Niagara handle packages?

Niagara has a list of packages that you can place inside the configuration file, and then it goes and checks it against the corresponding package for your linux distribution. A good example would be the following:

```json
{
    "name": "doas",
    "arch": "opendoas",
    "void": "opendoas"
}
```

This allows us to support multiple distributions, whilst making it a *write once, run anywhere* style of program.

## Features

- packages
- config
  - wallpaper
  - dotfile
  - scripts

## Example configuration

```json
{
  "packages": [
    "feh",
    "doas",
    "picom"
  ],
  "config": [
    {
      "option": "wallpaper",
      "val": "https://github.com/emacs-dashboard/emacs-dashboard/raw/master/banners/emacs.png"
    },
    {
      "option": "dotfile",
      "val": [
        "https://github.com/kavulox/nvim",
        "https://github.com/kavulox/picom"
      ]
    }
  ]
}
```

## Contributing

New contributors should submit a PR with a short description of their changes.

## ArtixLabs

Join our discord server at https://discord.gg/ajNswSyf6q

## Todo

- Get more packages 
  - Make packages support multiple package managers.
- Split deps.py into multiple files 
- Add documentation

## Author

**Niagara** was written by kavulox
