qpc - RPM command line tool for quipucords

qpc is the RPM command line tool for quipucords. To learn more about quipucords visit qpc man page.

Overview

This README file contains information about the installation and development of qpc, as well as instructions about where to find basic usage, known issues, and best practices information.

• Installation
• Command Syntax and Usage
• Development
• Issues
• Authors
• Contributing
• Copyright and License

Requirements and Assumptions

Before installing qpc on a system, review the following guidelines about installing and running qpc:

• qpc is written to run on RHEL or Fedora servers.
• The system that qpc is installed on must have access to the systems to be discovered and inspected.
• The target systems must be running SSH.
• The user account that qpc uses for the SSH connection into the target systems must have adequate permissions to run commands and read certain files, such as privilege escalation required for the systemctl command.
• The user account that qpc uses for a machine requires an sh shell or a similar shell. For example, the shell cannot be a /sbin/nologin or /bin/false shell.

The Python packages that are required for running qpc on a system can be found in the pyyproject.toml and poetry.lock file under "main" group. Development packages are under "dev" group.

Installation

dnf copr enable @quipucords/qpc
dnf install qpc

Command Syntax and Usage

The complete list of options for each qpc command and subcommand are listed in the qpc man page. The man page information also contains usage examples and some best practice recommendations.

For expanded information on credential entries, sources, scanning, and output, see the syntax and usage document.

Development

To work with the qpc code, begin by cloning the repository:

git clone git@github.com:quipucords/qpc.git

qpc development requires Python 3.12 and Poetry. Install using your local pakage manager or manually from:

• https://www.python.org/downloads/
• https://python-poetry.org/
• https://github.com/pyenv/pyenv/ (optional but encouraged)

Installation with development dependencies

This project uses poetry to manage python dependencies and virtual environment. Having poetry installed, just run the following to install the project:

poetry install

Linting

To lint changes that are made to the source code, run the following command::

make lint

Unit Testing

To run the unit tests, use the following command::

make test

Issues

To report bugs for qpc open issues against this repository in Github. Complete the issue template when opening a new bug to improve investigation and resolution time.

Authors

Authorship and current maintainer information can be found in AUTHORS.

Contributing

See the CONTRIBUTING guide for information about contributing to the project.

Copyright and License

Copyright 2017-2024, Red Hat, Inc.

quipucords is released under the GNU Public License version 3