gap-client 0.1.0

API for compliance tool

gap-client

Introduction

This is the official Python client for Gap Solutions APIs.

It is currently in heavy development, and not yet released in full version.

It is implemented as a Pyhton package, and made available on PyPi

Version string is stored in VERSION, and used by make to correctly tag artifacts.

Requirements are managed in requirements.in and compiled to requirements.txt with make req.

Development

Please note that this project uses a Makefile to manage it. Simply type make in the project folder for help

Set up environment

1. Install GNU make
   • NOTE: you will need gnu make. On windows, you can use WSL or gitbash).
2. Install Python 3.9 or newer
   • NOTE: Python for windows is here
3. Create virtual environment. (example: python -m venv ~/my_venv)
4. Activate virtual environment. (example: source ~/my_venv/bin/activate)
5. Install requirements for project: make req

Test

1. Run all test: make test

-- or --

1. Go to tests dir: cd tests
2. List available tests: make
3. Chose one test to run: make gap

NOTE: You can find the source code for the tests here

Build

1. Change version string: nano VERSION (edit and save the string)
2. Build project package: make pypi-build

Deploy

1. Make sure PYPI_TOKEN environment variable is set (set in pypi.org account)
2. Push project package to pypi: make pypi-push
3. Verify that the package version is uploaded to https://pypi.org/project/gap-client/

Use

In your project:

1. Put gap_client>=1.0.0 in project requirements.txt (substitute the version number to the latest)
2. Reload requirements with: pip install -r requirements.txt
3. Import the package with: from gap_client import Client as gap
4. Use the client. This example simply prints a hellp text: print(gap.hello_gap())

Examples

You can find examples here