Skip to main content

Port REST API Wrapper

Project description

Doc Coverage

PyPort 🚀

port-experimental - pyport stars - pyport forks - pyport

Repo metadata

Coverage Maintainability Security Dependencies

GitHub issues GitHub tag License Documentation

Package info

PyPI version PyPI - Python Version

Simplify Your REST Interactions
A Python SDK for the Port IDP REST API that handles authentication, error handling, and logging so you can focus on building your solutions.


🔍 Overview

Modern REST APIs can be powerful—but they aren’t always intuitive to work with. PyPort abstracts away the repetitive tasks of authentication, error handling, and logging, providing you with a clean, Pythonic client interface to interact with the Port IDP REST API.

Whether you're writing custom Python scripts or building larger applications, PyPort is designed to speed up your development process by simplifying REST operations.

Documentation & Support

For detailed information about the data model and code implementation, please refer to our comprehensive documentation at PyPort Documentation.


✨ Key Features

  • Intuitive Client Interface
    Interact with the Port IDP REST API effortlessly.

  • Automated Authentication
    Manage API tokens and credentials automatically.

  • Robust Error Handling
    Receive clear, actionable error messages for smooth debugging.

  • Integrated Logging
    Built-in logging to help you trace and monitor API interactions.

Note: Additional features and improvements are planned for future releases!


🔒 Security Scan Report

We've run a security scan on our code using Bandit. Check out the Security Scan Report for the details on what was found.


Installation

Install PyPort using pip:

pip install pyport

Usage

Below is a boilerplate example to help you get started with PyPort:

import os
from pyport import PortClient

PORT_CLIENT_ID = os.getenv("PORT_CLIENT_ID")
PORT_CLIENT_SECRET = os.getenv("PORT_CLIENT_SECRET")

port_client = PortClient(client_id=PORT_CLIENT_ID, client_secret=PORT_CLIENT_SECRET, us_region=True)
blueprints = port_client.blueprints.get_blueprints()

Happy Coding!

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

pyport-0.3.3.tar.gz (70.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyport-0.3.3-py3-none-any.whl (100.4 kB view details)

Uploaded Python 3

File details

Details for the file pyport-0.3.3.tar.gz.

File metadata

  • Download URL: pyport-0.3.3.tar.gz
  • Upload date:
  • Size: 70.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for pyport-0.3.3.tar.gz
Algorithm Hash digest
SHA256 d70fb6951dcab46560f34b58fc47bbaf4a227aadde992c92c8c2e1598100787d
MD5 f602a8c6715f09f2aeed5b202bee4245
BLAKE2b-256 ebe78744f0fbfefeb3e9d918bb819a264f2ad1d23f7f0dd43b45042c66a50e90

See more details on using hashes here.

File details

Details for the file pyport-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: pyport-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 100.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for pyport-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d196b3bd749a0c371bcd11690946b2e645a16b31db5dd0c975f439f0f7d0c4cb
MD5 578e0202f16f3efe377e1e8fac44aedc
BLAKE2b-256 9fede82b120be0b074eb41e8bef42f08ecb270728e5bf069292edebfc608069d

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