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. 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 project database.

Table of Contents

• Requirements
• Installation
  • From PyPI
  • Manual installation
  • Uninstall
• Usage
  • Example of execution
• Contributors
  • How do I contribute to xdg-ninja-report?
• License

Requirements

Here's a breakdown of the packages needed and their versions:

• poetry >= 1.7.1 (only for manual installation)
• core-helpers
• rich >= 13.7.1
• 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:

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 for a safe and isolated installation experience. Therefore, the appropriate command to install xdg-ninja-report would be:

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 from this repository:

   git clone https://github.com/YisusChrist/xdg-ninja-report
   cd xdg-ninja-report

2. Install the package:

   poetry install --only main

Uninstall

If you installed it from PyPI, you can use the following command:

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.

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 and help where you can.

See Contributing Guidelines for more details.

License

xdg-ninja-report is released under the GPL-3.0 License.