This is a guide for developers who would like to contribute to this project.
If you're interested in contributing to pgcli, first of all my heart felt
thanks. Fork the project in github. Then
clone your fork into your computer (git clone <url-for-your-fork>). Make
the changes and create the commits in your local machine. Then push those
changes to your fork. Then click on the pull request icon on github and create
a new pull request. Add a description about the change and send it along. I
promise to review the pull request in a reasonable window of time and get back
to you.
In order to keep your fork up to date with any changes from mainline, add a new git remote to your local copy called 'upstream' and point it to the main pgcli repo.
$ git remote add upstream git@github.com:dbcli/pgcli.git
Once the 'upstream' end point is added you can then periodically do a git
pull upstream master to update your local copy and then do a git push
origin master to keep your own fork up to date.
The installation instructions in the README file are intended for users of pgcli. If you're developing pgcli, you'll need to install it in a slightly different way so you can see the effects of your changes right away without having to go through the install cycle everytime you change the code.
It is highly recommended to use virtualenv for development. If you don't know what a virtualenv is, this guide will help you get started.
Create a virtualenv (let's call it pgcli-dev). Activate it:
source ./pgcli-dev/bin/activate
Once the virtualenv is activated, cd into the local clone of pgcli folder and install pgcli using pip as follows:
$ pip install --editable . or $ pip install -e .
This will install the necessary dependencies as well as install pgcli from the working folder into the virtualenv. By installing it using pip install -e we've linked the pgcli installation with the working copy. So any changes made to the code is immediately available in the installed version of pgcli. This makes it easy to change something in the code, launch pgcli and check the effects of your change.
If you want to work on adding new meta-commands (such as dp, ds, dy), you need to contribute to pgspecial project.
You will need Vagrant 1.7.2 or higher. In the project root there is a Vagrantfile that is setup to do multi-vm provisioning. If you're setting things up for the first time, then do:
$ version=x.y.z vagrant up debian $ version=x.y.z vagrant up centos
If you already have those VMs setup and you're merely creating a new version of DEB or RPM package, then you can do:
$ version=x.y.z vagrant provision
That will create a .deb file and a .rpm file.
The deb package can be installed as follows:
$ sudo dpkg -i pgcli*.deb # if dependencies are available. or $ sudo apt-get install -f pgcli*.deb # if dependencies are not available.
The rpm package can be installed as follows:
$ sudo yum install pgcli*.rpm
Integration tests use behave package and
pytest.
Configuration settings for this package are provided via a behave.ini file
in the tests directory. An example:
[behave] stderr_capture = false [behave.userdata] pg_test_user = dbuser pg_test_host = db.example.com pg_test_port = 30000
The database user has to have
permissions to create and drop test databases. Default user is postgres
at localhost, without the password (authentication mode trust).
First, install the requirements for testing:
$ pip install -r requirements-dev.txt
After that, tests can be run with:
$ cd tests $ behave $ py.test
To see stdout/stderr, use the following command:
$ behave --no-capture
PEP8 checks (lint) -----------------_
When you submit a PR, the changeset is checked for pep8 compliance using pep8radius. If you see a build failing because of these checks, install pep8radius and apply style fixes:
$ pip install pep8radius $ pep8radius master --docformatter --diff # view a diff of proposed fixes $ pep8radius master --docformatter --in-place # apply the fixes
Then commit and push the fixes.