Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yisuschrist/xdg-ninja-report
Check for dotfiles in the $HOME directory that are not reported by xdg-ninja
https://github.com/yisuschrist/xdg-ninja-report
dotfiles dotfiles-linux dotfiles-manager xdg xdg-ninja
Last synced: 27 days ago
JSON representation
Check for dotfiles in the $HOME directory that are not reported by xdg-ninja
- Host: GitHub
- URL: https://github.com/yisuschrist/xdg-ninja-report
- Owner: YisusChrist
- License: gpl-3.0
- Created: 2024-09-07T19:30:42.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-20T18:04:45.000Z (about 1 month ago)
- Last Synced: 2024-10-20T22:00:24.181Z (about 1 month ago)
- Topics: dotfiles, dotfiles-linux, dotfiles-manager, xdg, xdg-ninja
- Language: Python
- Homepage:
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Report Bug
·
Request Feature
·
Ask Question
·
Report security bug
`xdg-ninja-report` is a Python library that allows you to easily find the dotfiles that are not `XDG Base Directory Specification` compliant and are not recognized by [xdg-ninja](https://github.com/b3nj5m1n/xdg-ninja). This library is designed to be used in the terminal and is compatible with all operating systems that support Python. The aim of this tool is to help users submit new custom configurations to the [xdg-ninja](https://github.com/b3nj5m1n/xdg-ninja) project database.
Table of Contents
- [Requirements](#requirements)
- [Installation](#installation)
- [From PyPI](#from-pypi)
- [Manual installation](#manual-installation)
- [Uninstall](#uninstall)
- [Usage](#usage)
- [Example of execution](#example-of-execution)
- [Contributors](#contributors)
- [How do I contribute to xdg-ninja-report?](#how-do-i-contribute-to-xdg-ninja-report)
- [License](#license)
# Requirements
Here's a breakdown of the packages needed and their versions:
- [poetry](https://pypi.org/project/poetry) >= 1.7.1 (_only for manual installation_)
- [core-helpers](https://github.com/YisusChrist/core_helpers)
- [rich](https://pypi.org/project/rich) >= 13.7.1
- [string-grab](https://pypi.org/project/string-grab) >= 1.3.0
> [!NOTE]
> The software has been developed and tested using Python `3.12.1`. The minimum required version to run the software is Python 3.6. Although the software may work with previous versions, it is not guaranteed.
# Installation
## From PyPI
`xdg-ninja-report` can be installed easily as a PyPI package. Just run the following command:
```bash
pip3 install xdg-ninja-report
```
> [!IMPORTANT]
> For best practices and to avoid potential conflicts with your global Python environment, it is strongly recommended to install this program within a virtual environment. Avoid using the --user option for global installations. We highly recommend using [pipx](https://pypi.org/project/pipx) for a safe and isolated installation experience. Therefore, the appropriate command to install `xdg-ninja-report` would be:
>
> ```bash
> pipx install xdg-ninja-report
> ```
## Manual installation
If you prefer to install the program manually, follow these steps:
> [!WARNING]
> This will install the version from the latest commit, not the latest release.
1. Download the latest version of [xdg-ninja-report](https://github.com/YisusChrist/xdg-ninja-report) from this repository:
```sh
git clone https://github.com/YisusChrist/xdg-ninja-report
cd xdg-ninja-report
```
2. Install the package:
```sh
poetry install --only main
```
## Uninstall
If you installed it from PyPI, you can use the following command:
```bash
pipx uninstall xdg-ninja-report
```
# Usage
> [!TIP]
> For more information about the usage of the program, run `xdg_ninja_report --help` or `xdg_ninja_report -h`.
## Example of execution
# Contributors
## How do I contribute to xdg-ninja-report?
Before you participate in our delightful community, please read the [code of conduct](https://github.com/YisusChrist/.github/blob/main/CODE_OF_CONDUCT.md).
I'm far from being an expert and suspect there are many ways to improve – if you have ideas on how to make the configuration easier to maintain (and faster), don't hesitate to fork and send pull requests!
We also need people to test out pull requests. So take a look through [the open issues](https://github.com/YisusChrist/xdg-ninja-report/issues) and help where you can.
See [Contributing Guidelines](https://github.com/YisusChrist/.github/blob/main/CONTRIBUTING.md) for more details.
# License
`xdg-ninja-report` is released under the [GPL-3.0 License](https://opensource.org/license/GPL-3.0).