Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.17 KB

contributing.md

File metadata and controls

52 lines (34 loc) · 1.17 KB

Install

you will need to clone the directory first,

then, you need to install dependencies

pip install -r dev-requirements.txt
python setup.py -q install

and lastly install library as a local dependency

./setup.py develop

You can now use import asyncpgsa from other code bases and it will use the version you have locally

tests

We use pytest for tests.

The easiest and recommended way to run test suite is to use docker-compose:

docker-compose up --force-recreate --build

Otherwise, you need a local postgres running. It can be launched with docker-compose but it requires you to add ports: "5432:5432" to postgres service in docker-compose.yml. Then you can just launch:

docker-compose up -d postgres

Then, the tests can be run locally as:

pytest ./tests

Of course if you are running docker in a VM, like on a mac or windows you will also have to forward port 5432 from VM to the host.

You can also change the connection info in tests/__init__.py

The tests just run generic postgres queries. Nothing is created/deleted, so it should be safe if you also have other stuff in your local db.