Skip to main content

A python based package manager that builds programs from source

Project description

Travis Coveralls Stories in Ready Join the chat at https://gitter.im/starcraftman/pakit

Python License Version Status

Fork Me On Github

Description

Pakit is a small python based package manager that builds programs from source.

Pakit provides:

  1. A package manager interface to install, remove & update programs.

  2. A simple Recipe specification to build programs from source code.

  3. Premade and tested recipes maintained by pakit.

When you install a program Pakit will…

  1. download the source into a silo in pakit.paths.source and build it.

  2. install the program into a silo under pakit.paths.prefix.

  3. link the silo to the pakit.paths.link directory.

Want a longer explanation? See the Overview section.

Demo

The following demonstration covers most of the basic functions.

Pakit Demo

Try the demo yourself after installing pakit.

Install Pakit

To use pakit:

  1. Ensure you have a build environment for compiling the programs.

  2. Fetch pakit via pip or github.

  3. Modify your $PATH.

Build Environment

At this point pakit has two limitations to be aware of:

  • Relies on user’s build environment.

  • Pakit recipes can only depend on things pakit can build, currently limited pool. User needs to install any dependencies pakit can’t build.

To use pakit, I suggest you have…

  • c++ build environment

  • git

  • mercurial

  • anything a recipe depends on that pakit can’t build

For Ubuntu install these packages:

sudo apt-get install build-essential automake autoconf python-pip git mercurial liblzma-dev libevent-dev ncurses-dev

Github

Fetch the latest from the source. Works unless the build badge says failing.

git clone https://github.com/starcraftman/pakit.git
export PATH=$(pwd)/pakit/bin:$PATH
python pakit/setup.py deps release

pip

Install the latest stable pip release. It might be old but working.

sudo -H pip install pakit

PATH

By default, pakit will install programs under pakit.paths.prefix and link everything to pakit.paths.link. To use the built programs, pakit.paths.link/bin must be on your $PATH. So for example, with the default value of pakit.paths.link, you would need to:

export PATH=/tmp/pakit/links/bin:$PATH

The above exports will only last for the terminal session. To make them permanent for bash, edit $HOME/.bashrc or $HOME/.bash_aliases.

More Information

>From inside the pakit source folder:

  • Help: pakit --help

  • Consult man: man pakit

  • Read pydocs: pydoc pakit or pydoc pakit.shell and so on…

  • Install all development packages: python setup.py deps

  • Run the test suite: tox

  • See Waffle for things I’m working on.

  • Read DESIGN.md for details on design. A bit out of date.

Contributors

  • Jeremy Pallats/starcraft.man (that is me)

Overview

Basically I want to make a universal package manager on python. Runs everywhere, builds anything and handles dependencies. A bit like a meta build tool tying arbitrary recipes together. At the end of the day, will probably resemble Homebrew at least a little.

Importantly, the recipes should be configurable via a single YAML file that users can modify without changing the recipes. Say you want to pass particular flags to the vim or ag build, you’d just put them in an entry in the config.

Expected Feature Overview:

  • Python only, with minimal dependencies.

  • Package manager interface, install remove and update recipes.

  • 100% tested, framework & supported recipes.

  • Should work on any POSIX system, emphasis on Linux.

  • Simple recipe specification.

  • Configuration via a single YAML file.

  • Available via pip.

  • Traceability via logs for every command.

  • Premade & tested recipes available for use.

See DESIGN.md for more details.

Roadmap

For accurate plan, see waffle.io link above. Just a rough guess of what I should be implementing when.

0.1

  • [x] Implement basic tasks to install & remove ‘ag’ program.

  • [x] Support Git & Hg repositories.

  • [x] Simple config from .pakit.yml.

  • [x] Upgrade logic.

  • [x] User defined recipe locations via config.

  • [x] Pick a license.

  • [x] Pip/Wheel upload.

0.2

  • [x] Add archive support, supports download, hashing & extracting.

  • [x] Tar (tarfile)

  • [x] Zip (zipfile)

  • [x] tar.xz (xz command)

  • [x] Rar (rar command)

  • [x] 7z (7z command)

  • [x] Add list & searching support.

  • [x] Python 3 support

  • [x] Better error handling, rollback

  • [x] Improve Command, timeout & input file

  • [x] Investigate alternatives/improvements to RecipeDB

0.3

  • [ ] Make a website and promote. Maybe use github pages.

  • [x] Dependency logic between recipes tasks.

  • [x] Research best approach & do small design.

  • [x] Create Digraph Structure (likely required).

  • [x] Create Recipe specification & implement.

  • [ ] Handle missing commands inside recipes. For example, recipe needs git but git unavailable.

  • [x] Separate recipes from pakit core.

  • [ ] Move to pakit/pakit. pakit

0.4

  • [ ] Parallelism, envisioned as some task based dependency.

Beyond

  • [ ] Create tool to convert homebrew ruby formula. Maybe?

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

pakit-0.2.5.zip (59.1 kB view hashes)

Uploaded source

pakit-0.2.5.tar.gz (45.7 kB view hashes)

Uploaded source

Built Distribution

pakit-0.2.5-py2.py3-none-any.whl (48.5 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page