GHGA-Connector
A CLI - Client to perform up- and download operations to and from a local GHGA Node.
Documentation:
An extensive documentation can be found here (coming soon).
Quick Start:
Installation
This package uses PycURL and thus has curl (https://curl.se/) as a dependency. On Debian-based Linux distributions, you can install cURL using:
sudo apt install libcurl4-openssl-dev libssl-dev
This package is available at PyPI: https://pypi.org/project/ghga_connector
You can install it from there using:
pip install ghga_connector
Using the CLI:
To get help on the command line interface, type:
ghga_connector --help
Development
For setting up the development environment, we rely on the devcontainer feature of vscode in combination with Docker Compose.
To use it, you have to have Docker Compose as well as vscode with its "Remote - Containers" extension (ms-vscode-remote.remote-containers) installed.
Then open this repository in vscode and run the command
Remote-Containers: Reopen in Container from the vscode "Command Palette".
This will give you a full-fledged, pre-configured development environment including:
- infrastructural dependencies of the service (databases, etc.)
- all relevant vscode extensions pre-installed
- pre-configured linting and auto-formating
- a pre-configured debugger
- automatic license-header insertion
Moreover, inside the devcontainer, there are two convenience commands available (please type them in the integrated terminal of vscode):
dev_install- install the service with all development dependencies, installs pre-commit, and applies any migration scripts to the test database (please run that if you are starting the devcontainer for the first time or if you added any python dependencies to the./setup.cfg)dev_launcher- starts the service with the development config yaml (located in the./.devcontainer/dir)
If you prefer not to use vscode, you could get a similar setup (without the editor specific features) by running the following commands:
# Execute in the repo's root dir:
cd ./.devcontainer
# build and run the environment with docker-compose
docker-compose up
# attach to the main container:
# (you can open multiple shell sessions like this)
docker exec -it devcontainer_app_1 /bin/bash
License
This repository is free to use and modify according to the Apache 2.0 License.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ghga_connector-0.2.5.tar.gz.
File metadata
- Download URL: ghga_connector-0.2.5.tar.gz
- Upload date:
- Size: 26.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e6f6feae773d2ed160a7e104268670c637032f2f24b03a247a24778cdc5ce348
|
|
| MD5 |
c4269b40567bb3a57f8ff3b930fde808
|
|
| BLAKE2b-256 |
b181d581c210b8f5dfe8d7cc62272bb420aa5ec03b56e84cc3a117d372fa98cc
|
File details
Details for the file ghga_connector-0.2.5-py3-none-any.whl.
File metadata
- Download URL: ghga_connector-0.2.5-py3-none-any.whl
- Upload date:
- Size: 46.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7d8511806ee6d0d12222a8e89cb5524405f29a1af017bbf3873df0c2bbe2dcd4
|
|
| MD5 |
e81b5be8cdd2930ac6abffca29e0fbf3
|
|
| BLAKE2b-256 |
524a290c141fb354871213cfce4aca20743df0cd29f800179f19b58e65cb58e6
|
