Qcodo Package Manager (QPM)
The Qcodo Package Manager (QPM) was introduced starting with Qcodo v0.4.0 to allow community members a much more streamlined and efficient way to post and share modules, enhancements and fixes of the Qcodo Development Framework with each other.
The Qcodo.com website can be used to view user-submitted QPM packages that community members have contributed at QPM Section of the website.
To manage creating or downloading and installing QPM packages, please use the QPM tools that is included in your Qcodo distribution. For example, if you find a package named bar that has been submitted by user foo, you can install this QPM package by running the following
/path/to/my/cli/qcodo qpm-download foo/bar
For windows users, you could do the equivalent:
c:\path\to\my\cli\qcodo.bat qpm-download foo/bar
How to Create Your Own QPM Package
The Qcodo Community hopes and encourages all community members to post and share Qcodo contributions. QPM is by far the easiest way to do this.
If you have a QPM package you wish to share, please follow a few basic guidelines:
- Keep each package as small as possible, dedicating each package to the smallest unit of functionality that makes sense. E.g. instead of having a single QPM package that gives jquery, dojo, and Zend Framework functionality all at once, split the package into three individual QPM packages, one for each of the external frameworks you are trying to incorporate.
- Also, ensure you do not have custom (non Qcodo core) code in your files that do not directly pertain to the functionality of the QPM package.
- Build QPM packages on a completely clean install of Qcodo. Prior to building and submitting your QPM package, ensure that there are no files (new or edited) in your Qcodo installation that does NOT directly pertain to the QPM package that you are trying to submit.
- Build QPM packages from the most recent version of Qcodo. This will minimize any current or future incompatibilities, and will greatly aid in adoption of your QPM package.
- Give your QPM package a name that is clear and concise. Since the QPM handler on the website already handles versioning, avoid using version numbers in your QPM package name.
With all that in mind, if you have code you wish to submit as a QPM package, follow these steps:
- Go to http://www.qcodo.com/qpm and create a new QPM package with the desired QPM package name (if it doesn't yet exist)
- Download and do a clean install of the most recent version of Qcodo
- Place all files related to the functionality for this QPM into your clean install of Qcodo
- Run the following command to view what your package will look like:
/path/to/my/cli/qcodo qpm-upload -p=PASSWORD USERNAME/PACKAGENAME
For windows users, you can do:
c:\path\to\my\cli\qcodo.bat qpm-upload -p=PASSWORD cUSERNAME/PACKAGENAME
Check to make sure that everything looks alright. Are the correct new files being included? Are the correct modified files being included? Do these files only contain the code for the functionality of this QPM and nothing more?
If everything checks out okay, go ahead and rerun the above command with the --live switch and it will go ahead and package and submit your QPM package to Qcodo.com!
Prior to this, the old Qcodo.com website allowed community members to upload individual files to share code with each other, and while this will be phased out with the new QPM platform, the old downloads are still available to view and download here.
Frequently Asked Questions
What is QPM for, do I need to use it in order to work with Qcodo?
While you can use the base distribution of Qcodo just fine..
QPM is a central tool for
any packages containing
- patches in the bugtracker
- additional libraries (like Zend Framework integration)
making it essential if you want to work or participate with Qcodo.
Can I testdrive it?
Yes either by:
- or by submitting a test contribution in this ticket:
You can test out to send a patch with this ticket.. also share your tipps there so others get started easier.
When setting up QPM on Windows, what do I have to do? Which problems could arise?
1) Get started
Install PHP5.2* for Windows
Download the latest Qcodo
2) Problem using qcodo.bat shows the error message “wrong path”
So open cli/qcodo.bat and update the path to your php.exe
You have to take care of the path and put it in quotes when having a space in there
set PHP_COMMAND=“c:\Program Files\PHP\php.exe”
3) Problem qcodo says error: configuration.inc.php missing
You have to move the following files in the includes/ directory:
both reside in includes/qcodo/_core
configuration.inc.php DOCROOT should be set accordingly, eg.:
define ('__DOCROOT__', 'C:/QcodoPatches/qcodo/www');
4) Submit a patch
C:\QcodoPatches\qcodo>cli\qcodo.bat qpm-download -p=blabla cUsername/TESTBUG_package