diff options
author | Eric Young <YoungEricR@JohnDeere.com> | 2022-09-01 10:32:36 -0500 |
---|---|---|
committer | Eric Young <YoungEricR@JohnDeere.com> | 2022-09-01 10:32:36 -0500 |
commit | 79df61f674ddb1606c8445ba239eb03a769a4ad4 (patch) | |
tree | ef5aeeed22827f26c2ca2e23d9db1e4de0925a6b /DEVELOP.rst | |
parent | 94df104d7d4a97b93a28ed11f667f8e16431ed58 (diff) |
Small developer improvements for Windows-based devs.
Diffstat (limited to 'DEVELOP.rst')
-rw-r--r-- | DEVELOP.rst | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/DEVELOP.rst b/DEVELOP.rst index 0656905c..4cde6943 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.) :: |