_    _                  _     
                               ( )_ (_ )               ( )    
                  _ _      _   | ,_) | |  _   _    ___ | |/') 
                 ( '_`\  /'_`\ | |   | | ( ) ( ) /'___)| , <  
                 | (_) )( (_) )| |_  | | | (_) |( (___ | |\`\ 
                 | ,__/'`\___/'`\__)(___)`\___/'`\____)(_) (_)
                 | |                                          
                 (_)                                          

potluck
Copyright © 2011 Thomas Schreiber 
This program is distributed under the GPLv2 as specified in COPYING
Lead Developer: Thomas Schreiber <[email protected]>
Contributing Developers:
    Gregory Haynes

Description
============
A front-end to the popular Archlinux package manager, pacman. Potluck manages 
updates and new package installs for the user in a convenient Qt4 interface. 
Written in python, potluck takes advantage of the C library functions that are 
a part of pacman. As well as making standard package management more 
convenient, potluck also extends functionality similarly to yaourt to the Arch 
User Repository (AUR) which holds a collection of user submitted build scripts 
for various source tar-balls across the web. Potluck uses the AUR api to 
seamlessly integrate the AUR with the rest of the Archlinux repositories. The 
user can vote on build scripts and create their own. Allowing them to be part 
of the community package "potluck".

Build Instructions
===================
It is reccommended that you install potluck by building a package on your
Archlinux system.

<run as normal user>
$ cd arch/ && makepkg -s
<run as root>
# pacman -U potluck

Alternatively, potluck can be built in a build folder:
# python3 setup.py install


Qt Designer - Just some notes on Qt Designer
=============================================
I used Qt Designer to create a lot of the ui elements. So, a few commands
need to be run to update the ui files that Qt Designer creates.
$ pyuicy --from-imports mw.ui -o mwUi.py
$ pyuicy --from-imports changes.ui -o changesUi.py
$ pyrcc4 -py3 view/icons.qrc -o icons_rc.py


Contributing
=============
Contributions should be made through forking and pushing changes on github.
The projects github repo can be found at:
[email protected]:ubiquill/Potluck.git
If you have any issues please add them to the issue tracker at:
https://github.com/ubiquill/Potluck/issues

Style
======
1. All contributions should adhere to PEP 8.
2. Spaces should be used in place of tabs.
3. The following lines should be placed at the top of each file:
   #!/usr/bin/env python3
   # -*- coding: utf-8 -*-
4. The following line should be the last line of every file:
   # vim: set ts=4 sw=4 noet:
5. If you are patching a function or class please add a comment at the top of
   that code block with your name and contact info. For example:
   # contributions from Joe Smith <[email protected]>
   def func():
       ...
6. All new functions and classes need to have a doc string containing
   information about what it does and a list of parameters NOT including
   the self parameter.



Manifest
============
arch/
    |----PKGBUILD                           // Archlinux package file
COPYING                                     // License information
README                                      // This file
setup.py                                    // Python build file
src/
   |----__init__.py                         // Empty module file
   |----MainWindow.py                       // The Main Window controller
   |----model/
            |----Aur.py                     // Bindings to AUR API
            |----getBuildDepends.sh         // Lists build dependencies
            |----getConflicts.sh            // Lists conflicts
            |----getDepends.sh              // Lists dependencies
            |----__init__.py                // The model Module file
            |----Pacman.py                  // Bindings to the package Manager
            |----Transaction.py             // Class that integrates model
   |----potluck                             // Instantiates MainWindow instance
   |----view/
            |----Changes.py                 // Dialog window of changes
            |----changes.ui                 // QtDesigner file
            |----changesUi.py               // Output of QtDesigner file
            |----Dialogs.py                 // A number of custom QDialogs
            |----icons/
                      |----potlucklogo.png  // The potluck icon
            |----icons.qrc                  // Qt Resource file
            |----icons_rc.py                // Auto-generated py Qt resource
            |----__init__.py                // View module file
            |----mw.ui                      // QtDesigner file
            |----mwUi.py                    // Auto-generated py file
            |----proto.ui                   // QtDesigner file
            |----protoUi.py                 // Auto-generated py file

TODO:
------
Nothing right now