Skip to main content

CLI to make requests to Rekono API

Project description

Buy Me A Coffee

Command Line Interface to make requests to the Rekono API REST.

Usage

usage

Rekono API documentation is available in /api/schema/swagger-ui.html and /api/schema/redoc/ of Rekono instances

Library usage

Rekono CLI can be also used as Python 3 library, so that it's possible to create custom Rekono scripts. For example, with the following code it's possible to create a Rekono client to make custom API requests:

from rekono.client.api import Rekono
client = Rekono(url='https://127.0.0.1', token='my secret api token')           # Create Rekono client
response = client.get('/api/tools/1/')                                          # GET request to get tool with ID 1

Installation

PIP

pip3 install rekono-cli

From Source

  1. Install the required technologies: Python 3 & PIP

  2. Install the dependencies:

    pip3 install -r src/requirements.txt
    
  3. Execute the CLI:

    python3 src/rekono/main.py --help
    

Configuration

You can use the REKONO_TOKEN environment variable to configure the API token for Rekono authentication.

Reach Us

You can get support, ask questions, solve doubts or solve problems using:

Rekono is an open source project that we really love to maintain and it's absolutely our pleasure, but we would like to offer the possibility of supporting Rekono's development via donations. At the moment, the project only needs its maintainer's time to stay up to date with new features and fix bugs. However, in the future, it could need more expensive resources like hosting, new web pages for documentation, the inclusion of premium hacking tools, etc. With the help received from our supporters, Rekono will be able to grow fastly and have the resources that it deserves. Of course, you can use the donations just to appreciate our work. Thank you for your help!

The main differences between them are that BuyMeACoffe charges fees over each donation while Ko-fi doesn't and Ko-fi supports PayPal payments while BuyMeACoffe doesn't

License

Rekono is licensed under the GNU GENERAL PUBLIC LICENSE Version 3

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rekono-cli-2.0.1.post1.tar.gz (17.6 kB view details)

Uploaded Source

File details

Details for the file rekono-cli-2.0.1.post1.tar.gz.

File metadata

  • Download URL: rekono-cli-2.0.1.post1.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.16

File hashes

Hashes for rekono-cli-2.0.1.post1.tar.gz
Algorithm Hash digest
SHA256 ac32efa3e77dfc5c826bc580c49afe9a97c5be7f9da9a62fe9a734fc546abe79
MD5 23b0be9b64e2e5d1c353c4536def0d35
BLAKE2b-256 d2d9746e0ec84601fd2e8fa62eb830cad771e16d94c0bed1ba7e9aa575265daa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page