# gap-client
## Introduction
This is the official Python client for [Gap Solutions](https://gapsolutions.dk/) 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](https://pypi.org)
Version string is stored in [VERSION](./VERSION), and used by make to correctly tag artifacts.
Requirements are managed in [requirements.in](./requirements/requirements.in) and compiled to [requirements.txt](./requirements/requirements.txt) with `make req`.
## Development
Please note that this project uses a [Makefile](./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](https://learn.microsoft.com/en-us/windows/wsl/about) or [gitbash](https://gitforwindows.org/)).
1. Install Python 3.9 or newer
* NOTE: Python for windows is [here](https://www.python.org/downloads/windows/)
1. Create [virtual environment](https://docs.python.org/3/library/venv.html). (example: `python -m venv ~/my_venv`)
1. Activate virtual environment. (example: `source ~/my_venv/bin/activate`)
1. Install requirements for project: `make req`
### Test
1. Run all test: `make test`
> -- or --
1. Go to tests dir: `cd tests`
1. List available tests: `make`
1. Chose one test to run: `make gap`
> NOTE: You can find the source code for the tests [here](./tests/)
### Build
1. Change version string: `nano VERSION` *(edit and save the string)*
1. Build project package: `make pypi-build`
### Deploy
1. Make sure `PYPI_TOKEN` environment variable is set (*set in pypi.org account*)
1. Push project package to pypi: `make pypi-push`
1. Verify that the package version is uploaded to [https://pypi.org/project/gap-client/](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*)
1. Reload requirements with: `pip install -r requirements.txt`
1. Import the package with: `from gap_client import Client as gap`
1. Use the client. This example simply prints a hellp text: `print(gap.hello_gap())`
### Examples
You can find examples [here](./examples/)
Raw data
{
"_id": null,
"home_page": "https://github.com/arribatec-cloud-1/gap-client",
"name": "gap-client",
"maintainer": "Gap Solutions",
"docs_url": null,
"requires_python": ">=3.9.20",
"maintainer_email": "pypi@gapsolutions.dk",
"keywords": "python3, compliance",
"author": "Gap Solutions",
"author_email": "pypi@gapsolutions.dk",
"download_url": "https://files.pythonhosted.org/packages/d5/1f/1ee6cb973dae182ce5f4e2f968029abd04346e17e7f58afa1498a866f6b6/gap-client-0.1.0.tar.gz",
"platform": "Linux",
"description": "# gap-client\n\n\n\n\n## Introduction\n\nThis is the official Python client for [Gap Solutions](https://gapsolutions.dk/) APIs.\n\nIt is currently in heavy development, and not yet released in full version.\n\nIt is implemented as a Pyhton package, and made available on [PyPi](https://pypi.org)\n\nVersion string is stored in [VERSION](./VERSION), and used by make to correctly tag artifacts.\n\nRequirements are managed in [requirements.in](./requirements/requirements.in) and compiled to [requirements.txt](./requirements/requirements.txt) with `make req`.\n\n\n## Development\n\nPlease note that this project uses a [Makefile](./Makefile) to manage it. Simply type `make` in the project folder for help\n\n### Set up environment\n\n1. Install GNU make\n * NOTE: you will need gnu make. On windows, you can use [WSL](https://learn.microsoft.com/en-us/windows/wsl/about) or [gitbash](https://gitforwindows.org/)).\n1. Install Python 3.9 or newer\n * NOTE: Python for windows is [here](https://www.python.org/downloads/windows/)\n1. Create [virtual environment](https://docs.python.org/3/library/venv.html). (example: `python -m venv ~/my_venv`)\n1. Activate virtual environment. (example: `source ~/my_venv/bin/activate`)\n1. Install requirements for project: `make req`\n\n\n### Test\n\n1. Run all test: `make test`\n\n> -- or --\n\n1. Go to tests dir: `cd tests`\n1. List available tests: `make`\n1. Chose one test to run: `make gap`\n\n> NOTE: You can find the source code for the tests [here](./tests/)\n\n### Build\n\n1. Change version string: `nano VERSION` *(edit and save the string)*\n1. Build project package: `make pypi-build`\n\n### Deploy\n\n1. Make sure `PYPI_TOKEN` environment variable is set (*set in pypi.org account*)\n1. Push project package to pypi: `make pypi-push`\n1. Verify that the package version is uploaded to [https://pypi.org/project/gap-client/](https://pypi.org/project/gap-client/)\n\n### Use\n\nIn your project:\n1. Put `gap_client>=1.0.0` in project `requirements.txt` (*substitute the version number to the latest*)\n1. Reload requirements with: `pip install -r requirements.txt`\n1. Import the package with: `from gap_client import Client as gap`\n1. Use the client. This example simply prints a hellp text: `print(gap.hello_gap())`\n\n### Examples\n\nYou can find examples [here](./examples/)\n",
"bugtrack_url": null,
"license": "Proprietary",
"summary": "API for compliance tool",
"version": "0.1.0",
"project_urls": {
"Docs": "https://github.com/arribatec-cloud-1/gap-client/blob/main/README.md",
"Download": "https://pypi.org/project/gap-client/",
"Homepage": "https://github.com/arribatec-cloud-1/gap-client"
},
"split_keywords": [
"python3",
" compliance"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d51f1ee6cb973dae182ce5f4e2f968029abd04346e17e7f58afa1498a866f6b6",
"md5": "0d10b2ef60877114194d397fabc82b9f",
"sha256": "bc15d421ca1d7e6468436be449f35a2aa60d5388b37be88a2ddac1b0ba8ae91a"
},
"downloads": -1,
"filename": "gap-client-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "0d10b2ef60877114194d397fabc82b9f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.20",
"size": 33646,
"upload_time": "2024-09-26T11:36:59",
"upload_time_iso_8601": "2024-09-26T11:36:59.051050Z",
"url": "https://files.pythonhosted.org/packages/d5/1f/1ee6cb973dae182ce5f4e2f968029abd04346e17e7f58afa1498a866f6b6/gap-client-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-26 11:36:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "arribatec-cloud-1",
"github_project": "gap-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gap-client"
}
JSON
