Project Title

Write a short description about the project, its use cases, and its solutions.

TLDR

• Run make bash to spawn a terminal providing a configured runtime environment to debug, test and run the package.
• Run make lint to check code style and quality.
• Run make test to run the tests.
• Run make clean to cleanup artifacts.
• Run make runserver to start a demo/debug server.
• Run make bump-(major|minor|patch|prerelease|build) to increase the major, minor, patch, prerelease or build version respectively.

Installation

Before you begin

Before you can install the iam.ext.idc package, you need to ensure that the required dependencies are provided in your operating system environment:

1. Ensure that a supported Python version is installed (3.5, 3.6, 3.7, 3.8, 3.9).

2. Ensure that the following command-line tools are available:

   • awk, cp, mv, rm, sha1sum, sha256sum, and sed; available on POSIX systems.
   • curl
   • git
   • make

3. Install pip using cURL:

   curl https://bootstrap.pypa.io/get-pip.py | /usr/bin/env python3
   

4. Install or update the required packages and libraries on your operating system:

   • Debian/Ubuntu:

     apt-get install -y libffi-dev openssl-dev
     

   • Alpine Linux:

     apk add libffi-dev libressl-dev
     

   • Fedora/Red Hat Enterprise Linux/CentOS

     dnf install libffi-devel openssl-devel
     

   You can skip this step if you plan to always use the package or application inside a Docker container.

Additional packages may need to be installed for specific use cases.

For additional details on the configuration of your operating system environment, refer to the technical documentation.

System-wide installation

Run the following command in a terminal to install the iam.ext.idc package:

pip install iam.ext.idc

Usage - Basic Example

Provide an example of basic usage.

from mypkg import HolyHandGrenade

Resources

• Provide a link to the technical documentation of this project.
• Provide other links that may be relevant to the reader.

License

Proprietary

Author information

This Python package was created by Cochise Ruhulessin for the Unimatrix One project.

• Send me an email
• GitLab
• GitHub
• LinkedIn
• Twitter