pcurate 0.1.6
utility for curating Arch Linux software package lists
License: MIT
Requires Python: >=3.9,<4.0

## pcurate

Pcurate is a command line utility with the purpose of 'curating' or carefully arranging lists of explicitly installed Arch Linux software packages.

I created this because I was often updating text files with lists of installed software and notes concerning many packages.  It became a chore to manage that information for a number of uniquely configured hosts, and keeping it in sync with changes.

This utility provides a convenient way to organize software stacks into package lists which can either be fed back to the package manager for automatic installation, or simply used for reference and planning.

### Features include

 - Tagging/categorization of curated packages, for easier filtering and sorting
 - Alternate package descriptions can be set, such as the reason for installation
 - Data is exportable to a simple package list or comma delimited (csv) format
 - Optional filter.txt file for specifying packages or package groups to be excluded
 - Option to limit display output to only include either native or foreign packages

Note:  Package version information is untracked because Arch Linux is a rolling release distribution, and this utility is not meant to aid in maintaining partial upgrades.  If needed, notes on versioning can be stored in a package tag or description attribute.

###  Installation

Install or upgrade to latest version using pip

	$ python -m pip install pcurate --user --upgrade

### Usage

	$ pcurate -h
	pcurate

	Usage:
	  pcurate PACKAGE_NAME [-u | -s [-t TAG] [-d DESCRIPTION]]
	  pcurate ( -c | -r | -m ) [-n | -f] [-v]
	  pcurate ( -h | --help | --version)

	Options:
	  -u --unset              Unset package curated status
	  -s --set                Set package curated status
	  -t tag --tag tag        Set package tag
	  -d desc --desc desc     Set package description
	  -c --curated            Display all curated packages
	  -r --regular            Display packages not curated
	  -m --missing            Display missing curated packages
	  -n --native             Limit display to native packages
      -f --foreign            Limit display to foreign packages
	  -v --verbose            Display additional info (csv)
	  -h --help               Display help
	  --version               Display pcurate version

### Examples

Display information for a package

	$ pcurate firefox

Set a package as curated status (a keeper)

	$ pcurate -s vim

Unset a package to revoke its curated status (and remove any tag or custom description)

	$ pcurate -u emacs

Set a package with an optional tag and custom description

	$ pcurate -s mousepad -t editors -d "my cat installed this"


The following is a command I use to interactively mark multiple packages as curated.  **Tab** or **Shift**+**Tab** to mark or unmark, commit with **Enter** or cancel with **Esc**.  This requires [fzf](https://archlinux.org/packages/community/x86_64/fzf/) to be installed.

	$ pcurate -r | fzf -m | xargs -I % pcurate -s %

#### Package List examples

Display a list of regular packages (those which are installed but not yet curated)

	$ pcurate -r

Display a list of curated packages that are missing (either no longer installed or their install reason has been changed to dependency).

	$ pcurate -m

Set curated status for all packages listed in an existing pkglist.txt file (a simple text file containing a newline separated list of package names)

	$ cat pkglist.txt | xargs -I % pcurate -s %

Export all curated native packages to a new pkglist.txt file

	$ pcurate -cn > pkglist.txt

Send the resulting pkglist.txt to package manager for automatic installation

	$ pacman -S --needed - < pkglist.txt

Write a detailed list of curated packages to csv format so you can view it as a spreadsheet, etc.

	$ pcurate -cv > pkglist.csv

#### Configuration

**$XDG_CONFIG_HOME/pcurate** or **~/.config/pcurate** is the default location for the package database and filter.txt file.  The optional filter.txt file is a simple newline separated list of packages or package groups.  Single line comments can also be added.

Any packages or members of package groups listed in the filter.txt will be purged from the pcurate database and excluded from command output.  Filter rules are only applied against regular packages.

### License
The MIT License (MIT)

Copyright © 2021 Scott Reed