Skip to content

Implement reporting and update-security-db commands #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dharapandya85 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Implement reporting and update-security-db commands #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
349 changes: 349 additions & 0 deletions archpkg.egg-info/PKG-INFO
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,349 @@
Metadata-Version: 2.4
Name: archpkg
Version: 0.1.0
Summary: Your ArchPkg CLI tool
Author: AdmGenSameer
Author-email: AdmGenSameer <sameers00324@gmail.com>
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: rich
Requires-Dist: typer[all]
Requires-Dist: distro
Dynamic: author
Dynamic: license-file
Dynamic: requires-python

# archpkg-helper

A cross-distro command-line utility that helps you search for packages and generate install commands for native package managers (pacman, AUR, apt, dnf, flatpak, snap). It aims to make discovering and installing software on Linux simpler, regardless of your distribution.

## Table of Contents

- [About](#about)
- [Features](#features)
- [Quick Start (install.sh)](#quick-start-installsh)
- [Installation (Recommended: pipx)](#installation-recommended-pipx)
- [Alternative Installation (pip)](#alternative-installation-pip)
- [Usage](#usage)
- [File Structure](#file-structure)
- [Contributing](#contributing)
- [License](#license)

## About

archpkg-helper is designed to work across Linux distributions. While originally inspired by Arch Linux, it detects your system and generates appropriate install commands for common package managers. It’s suitable for both newcomers and experienced users who want a simpler way to search and install packages.

## Features

- Search for packages and generate install commands for:
- pacman (Arch), AUR, apt (Debian/Ubuntu), dnf (Fedora), flatpak, snap
- Cross-distro support (not limited to Arch)
- Clear, readable output and errors
- One-command setup via `install.sh`

## Quick Start (install.sh)

Install directly using the provided installer script.

From a cloned repository:
```sh
git clone https://github.com/AdmGenSameer/archpkg-helper.git
cd archpkg-helper
bash install.sh
```

Or run directly from the web:
```sh
curl -fsSL https://raw.githubusercontent.com/AdmGenSameer/archpkg-helper/main/install.sh | bash
# or
wget -qO- https://raw.githubusercontent.com/AdmGenSameer/archpkg-helper/main/install.sh | bash
```

Notes:
- The installer ensures Python, pip, and pipx are available and installs the CLI via pipx.
- You may be prompted for sudo to install prerequisites on your distro.

## Installation (Recommended: pipx)

On Arch and many other distros, system Python may be “externally managed” (PEP 668), which prevents global pip installs. pipx installs Python CLIs into isolated environments and puts their executables on your PATH—this is the easiest, safest method.

1) Install pipx
- Arch Linux:
```sh
sudo pacman -S pipx
pipx ensurepath
```
- Debian/Ubuntu:
```sh
sudo apt update
sudo apt install pipx
pipx ensurepath
```
- Fedora:
```sh
sudo dnf install pipx
pipx ensurepath
```

2) Install archpkg-helper with pipx
- Directly from GitHub:
```sh
pipx install git+https://github.com/AdmGenSameer/archpkg-helper.git
```
- From a local clone:
```sh
git clone https://github.com/AdmGenSameer/archpkg-helper.git
cd archpkg-helper
pipx install .
```

Upgrade later with:
```sh
pipx upgrade archpkg-helper
```

Ensure your shell session has pipx’s bin path in PATH (pipx prints instructions after `pipx ensurepath`, typically `~/.local/bin`).

## Alternative Installation (pip)

If you prefer pip, install in user scope to avoid system conflicts:

- From a local clone:
```sh
git clone https://github.com/AdmGenSameer/archpkg-helper.git
cd archpkg-helper
python3 -m pip install --user .
```
- Directly from GitHub:
```sh
python3 -m pip install --user git+https://github.com/AdmGenSameer/archpkg-helper.git
```

If your distro enforces PEP 668 protections for global installs, you may see errors. You can bypass with:
```sh
python3 -m pip install --break-system-packages .
```
However, using pipx is strongly recommended instead of breaking system protections.

## Usage

After installation, the CLI is available as `archpkg`.

---

### Example Commands

Here are some common commands for using the archpkg tool:

#### 1. Search for a Package

Search for a package across all supported package managers:

```sh
archpkg search firefox
```


This command will search for the `firefox` package across multiple package managers (e.g., pacman, AUR, apt).

#### 2. Install a Package

Once you have identified a package, use the install command to generate the correct installation command for your system:

```sh
archpkg install firefox
```


This will generate an appropriate installation command (e.g., `pacman -S firefox` for Arch-based systems).

#### 3. Install a Package from AUR (Arch User Repository)

To install from the AUR specifically:

```sh
archpkg install vscode --source aur
```


This installs `vscode` from the AUR.

#### 4. Install a Package from Pacman

To install a package directly using pacman (e.g., on Arch Linux):

```sh
archpkg install firefox --source pacman
```


#### 5. Remove a Package

To generate commands to remove a package:

```sh
archpkg remove firefox
```


This will generate the command necessary to uninstall `firefox` from your system.

---

### Optional Flags

#### 1. `--source <source>`

You can specify the package manager source using the `--source` flag. Supported sources include:

- pacman (Arch Linux)
- aur (AUR)
- apt (Debian/Ubuntu)
- dnf (Fedora)
- flatpak (Flatpak)
- snap (Snap)

For example, to install `vscode` from the AUR:

```sh
archpkg install vscode --source aur
```


#### 2. `--help`

To view a list of available commands and options:

```sh
archpkg --help
```


#### 3. `--version`

To check the installed version of archpkg:

```sh
archpkg --version
```
---

## 🏗️ Architecture

The tool is structured as a **modular Python CLI** with:

- 📝 **Command Parser**
Handles subcommands like `search`, `install`, `remove`.

- 🔌 **Backend Adapters**
Provides an abstraction layer for each package manager:
- `pacman` (Arch Linux)
- `aur` (Arch User Repository)
- `apt` (Debian/Ubuntu)
- `dnf` (Fedora)
- `flatpak`
- `snap`

- 🖥️ **System Detector**
Automatically detects your Linux distribution and selects the correct package manager.

- ⚡ **Installer Script (`install.sh`)**
One-line setup that ensures Python, pip, and pipx are installed before deploying `archpkg`.

This modular architecture makes the project **extensible** — new package managers can be added with minimal changes.

---

## Tips for Beginners

- **Start by Searching:** Before installing anything, try using the `archpkg search <package-name>` command to check if the package exists and where it can be installed from.

```sh
archpkg search firefox
```


This will list all available versions of Firefox across supported sources.

- **Understand Sources and Flags:** By default, archpkg will try to find packages from the most common sources. If you prefer to use a specific source (e.g., AUR or pacman), you can specify it using the `--source` flag.

```sh
archpkg install vscode --source aur
```


- **Keep It Simple with Installation:** Once you find the package you want, use the `archpkg install <package-name>` command to generate the installation command for your system.

- **Removal Commands:** Don’t forget that archpkg can also generate commands for removing installed packages. For example:

```sh
archpkg remove firefox
```


- **Auto-detect Your Package Manager:** If you’re unsure which package manager your distro uses, The archpkg-helper tool can automatically detect your system, making it easier to get started without manual configuration.

- **Handle Permission Errors with sudo:** If you encounter permission errors, try using `sudo` (superuser privileges) for commands that require administrative rights, especially when installing prerequisites or system packages.


---

## File Structure

Top-level layout of this repository:
```
archpkg-helper/
├── archpkg/ # Core Python package code (CLI and logic)
├── install.sh # One-command installer script (uses pipx)
├── pyproject.toml # Build/metadata configuration
├── setup.py # Packaging configuration (entry points, deps)
├── LICENSE # Project license (Apache 2.0)
├── README.md # Project documentation (this file)
├── build/ # Build artifacts (may appear after builds)
├── __pycache__/ # Python bytecode cache (auto-generated)
├── archpkg_helper.egg-info/ # Packaging metadata (auto-generated)
└── archpy.egg-info/ # Packaging metadata (auto-generated)
```

Some metadata/build directories are generated during packaging and may not be present in fresh clones.

## Notes

- The installer ensures Python, pip, and pipx are available.
- You may be prompted for sudo.

## Contributing

Contributions are welcome! Please:
1. Fork the repository
2. Create a feature branch: `git checkout -b feature-branch`
3. Make your changes and commit: `git commit -m "Describe your changes"`
4. Push to your fork: `git push origin feature-branch`
5. Open a Pull Request

Report bugs or request features via the [issue tracker](https://github.com/AdmGenSameer/archpkg-helper/issues).
---

## 🛣️ Roadmap

Here’s what’s planned for future releases of **archpkg-helper**:

- 🔧 **Add support for `zypper` (openSUSE)**
Extend backend adapters to cover openSUSE users.

- ⚡ **Caching layer for faster searches**
Improve performance by reducing repeated lookups across package managers.

- 💻 **Interactive mode (`archpkg interactive`)**
A guided, menu-driven interface to search, choose a package source, and install/remove easily.

- 🖼️ **GUI frontend (future idea)**
Build a graphical user interface on top of the CLI for desktop users who prefer point-and-click.

---

## License

This project is licensed under the [Apache License 2.0](./LICENSE).
25 changes: 25 additions & 0 deletions archpkg.egg-info/SOURCES.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
LICENSE
README.md
pyproject.toml
setup.py
archpkg/__init__.py
archpkg/__main__.py
archpkg/cli.py
archpkg/command_gen.py
archpkg/config.py
archpkg/exceptions.py
archpkg/logging_config.py
archpkg/paths.py
archpkg/search_apt.py
archpkg/search_aur.py
archpkg/search_dnf.py
archpkg/search_flatpak.py
archpkg/search_pacman.py
archpkg/search_snap.py
archpkg/security.py
archpkg.egg-info/PKG-INFO
archpkg.egg-info/SOURCES.txt
archpkg.egg-info/dependency_links.txt
archpkg.egg-info/entry_points.txt
archpkg.egg-info/requires.txt
archpkg.egg-info/top_level.txt
1 change: 1 addition & 0 deletions archpkg.egg-info/dependency_links.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

2 changes: 2 additions & 0 deletions archpkg.egg-info/entry_points.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[console_scripts]
archpkg = archpkg.cli:app
4 changes: 4 additions & 0 deletions archpkg.egg-info/requires.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
requests
rich
typer[all]
distro
1 change: 1 addition & 0 deletions archpkg.egg-info/top_level.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
archpkg
Loading