diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-09-21 01:44:43 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-09-21 01:44:53 +0000 |
commit | 97864fef063b0960fd3df4529c561296e7805e8c (patch) | |
tree | e0f84cbf2df15e6c8dafb6161babb551d6b6fda6 /DEVELOP.rst | |
parent | Releasing debian version 3.4.1-1. (diff) | |
download | pgcli-97864fef063b0960fd3df4529c561296e7805e8c.tar.xz pgcli-97864fef063b0960fd3df4529c561296e7805e8c.zip |
Merging upstream version 3.5.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'DEVELOP.rst')
-rw-r--r-- | DEVELOP.rst | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/DEVELOP.rst b/DEVELOP.rst index e262823..4cde694 100644 --- a/DEVELOP.rst +++ b/DEVELOP.rst @@ -48,6 +48,10 @@ Create a virtualenv (let's call it pgcli-dev). Activate it: source ./pgcli-dev/bin/activate + or + + .\pgcli-dev\scripts\activate (for Windows) + Once the virtualenv is activated, `cd` into the local clone of pgcli folder and install pgcli using pip as follows: @@ -73,6 +77,37 @@ If you want to work on adding new meta-commands (such as `\dp`, `\ds`, `dy`), you need to contribute to `pgspecial <https://github.com/dbcli/pgspecial/>`_ project. +Visual Studio Code Debugging +----------------------------- +To set up Visual Studio Code to debug pgcli requires a launch.json file. + +Within the project, create a file: .vscode\\launch.json like below. + +:: + + { + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "name": "Python: Module", + "type": "python", + "request": "launch", + "module": "pgcli.main", + "justMyCode": false, + "console": "externalTerminal", + "env": { + "PGUSER": "postgres", + "PGPASS": "password", + "PGHOST": "localhost", + "PGPORT": "5432" + } + } + ] + } + Building RPM and DEB packages ----------------------------- @@ -145,6 +180,7 @@ service for the changes to take effect. $ sudo service postgresql restart After that, tests in the ``/pgcli/tests`` directory can be run with: +(Note that these ``behave`` tests do not currently work when developing on Windows due to pexpect incompatibility.) :: @@ -176,3 +212,8 @@ Coding Style ------------ ``pgcli`` uses `black <https://github.com/ambv/black>`_ to format the source code. Make sure to install black. + +Releases +-------- + +If you're the person responsible for releasing `pgcli`, `this guide <https://github.com/dbcli/pgcli/blob/main/RELEASES.md>`_ is for you. |