Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/learnixos/pms

pms - pack my sh*t (or software) is a minimal package manager that functions more in line with Arch's PKGBUILDS and Gentoo's ebuilds.
https://github.com/learnixos/pms

c linux minimal package-management package-manager

Last synced: about 2 months ago
JSON representation

pms - pack my sh*t (or software) is a minimal package manager that functions more in line with Arch's PKGBUILDS and Gentoo's ebuilds.

Awesome Lists containing this project

README 

        
# Pack My Sh*t

## What is PMS?

PMS is essentially a minimal package manager. Okay, not really, for now, it just runs basic build scripts in the form of a .json.

It is also the official package manager of the famous LearnixOS, the greatest distro (in production) of all time.

## Why make this?

Hi I'm cowmonk, the founder and maintainer of this beauty, being a gigachad LFS user, I felt it was time to start making my own package manager, and with the firey passion to do something in C, pms came into fruition.

My idea was simple: What makes other package managers so bad? Well, here are some of the things I compiled:

- It's slow as hell! (I'm looking at you apt)

- It's not intuitive enough!

- It's not SUCKLESS! (Over engineered!)

- and much more! I wouldn't want to get into a long rant about it.

The main reason was #3, there are rarely any "suckless"-like package managers, so I really wanted to make one. Since we already have suckless core (I use it on my LFS system), it's time to also expand that amazing ecosystem.

### Where the name originates

I have to give credit because the name pms originally came from Learnix's discord server from a **very** active member of the community, if you want to know him, you will have to 👊 SMASH 👊 THAT SUBSCRIBE BUTTON and join LearnixTV's discord server 😜.

As also the creator of LearnixOS, although it's kinda in a perpetual shadow prison because I haven't really gotten any time because of work and among other things, pms was originally made as an idea for LearnixOS, in which was supposed to be LFS based. Of course, seeing how pms is now in my repository, LearnixOS has moved from being LFS based, to Gentoo based, to finally being decided as being Void based.

## Planned features

- Json package builds

  - No longer that we must SUFFER with the terrible looks and garbage looking ebuilds and PKGBUILDS from arch, and the difficulty of understanding what it really does (I'm looking at you gentoo, it's okay but I really don't like the fact you can't see what enabling USE flags will do in ebuilds). I am also hopping it makes the barrier to entry a lot easier, creating an "AUR" or "Gentoo Overlays" of some sort. Of course, for now, creating these json pkg build files are all manual, which can get annoying, which a automation of creating pkg build files will be created one day.

- Minimal to the bone!

  - For now, I am trying to get the base stuff down, creating a package manager is not easy but I will try my best to follow suckless philosophy and make it easy to hack. Additionally I do want to minimize the dependencies and make sure it's as lightweight as I can, obviously, my choice in using json as the pkg build was obviously a cosmetic choice. Comments are seen throughout the project and they can help some people understand the mess of a job I am doing.

- So easy to use, even a baby can use it!

  - As this is more of a build script package manager, it will be sourced based, however using gentoo's portage manager as a guide, I want to make pms have less sloc and minimal whilst the tools and utility of the package will be as similar or even better than portage, such as syncing and updating packages, (and maybe even USE flags). This will come with time, as I will have to figure out how to implement a USE flag system to pms.

- And much more to come!

# Building

### Prerequisites:

- C compiler (such as clang, gcc, or tcc)

- C libraries

- make

- curl

- cjson[^1]

#### Runtime Dependencies

- tar

- unzip

#### Optional dependencies

- git (repo support and development versions of packages, which is coming soon)

### Actually building it

You will either download the tar from the releases, or get the development pms through git.

Either way, the process will be basically the same. Here's the process (for the development version):

```bash

git clone https://github.com/Rekketstone/pms.git pms

cd pms

make

sudo/doas make install

```

It is recommended to edit the config.h like how you do with dwm. Make changes as you wish.

# Usage

### The pkg.json file

The naming scheme can be anything you desire, but to be frank, the hope is that the naming will be like this in pratice: {package_name}-{ver}.json

Here is an example json package file for your viewing desires

###### mypackage-1.0.0.json

```json

{

  "pkgname": "mypackage",

  "version": "1.0.0",

  "source": ["http://example.com/mypackage-1.0.0.tar.gz"],

  "patches": [ // This can be omitted from the file no problem, this is just optional

    "http://example.com/nofstack.patch",

    "http://example.com/security.patch"

  ],

  "build": [ // sources are extracted automatically no need for tar xvf tarbal.tar.xz or unzip

    "cd mypackage-1.0.0", // head into the extract sources (it is automatically patched for you)

    "./configure",

    "make",

    "make install"  // Placeholder - actual installation would need to be defined.

  ],

   "depends": ["libxyz", "libpng", "libass"]

}

```

### Running pms

For now pms is very bare, with only four arguments that you can parse to it. You can only run build scripts for now following the mypackage.json example.

```bash

$ pms --version

pms - Pack My Sh*t version: 0.0.1-beta

$ pms --help

Usage: pms [options] 

Options:

    -h, --help      Display this help message

    -v, --version   Display version information

$ pms --quiet neofetch.json

Fetching sources... Skipping download: 7.1.0.tar.gz already downloaded!

neofetch-7.1.0/

neofetch-7.1.0/.github/

neofetch-7.1.0/.github/ISSUE_TEMPLATE.md

neofetch-7.1.0/.github/PULL_REQUEST_TEMPLATE.md

neofetch-7.1.0/.travis.yml

neofetch-7.1.0/CONTRIBUTING.md

neofetch-7.1.0/LICENSE.md

neofetch-7.1.0/Makefile

neofetch-7.1.0/README.md

neofetch-7.1.0/neofetch

neofetch-7.1.0/neofetch.1

```

Report any bugs and help make this project become an actual usable source based package manager!

##### Current SLOC count (including header files, Dec 5, 24): ~614

# Credits

It's because of these projects that pms can actually function, so thanks :-)

- [CJSON](https://github.com/DaveGamble/cJSON)

  - "Ultralightweight JSON parser in ANSI C"

[^1]: https://github.com/DaveGamble/cJSON