Skip to main content

A Python client library for interacting with the specific API.

Project description

Contributor Covenant

Point Of Presence Python Client Library

A Python client library for interacting with a specific POP API. This library provides easy-to-use methods for performing GET, POST, PUT, PATCH and DELETE requests, with built-in authentication support.

Table of Contents

Installation

Ensure you have Python 3.6 or higher installed. It's recommended to use a virtual environment.

Option 1: Install from GitHub

  1. Clone the repository:

    git clone https://github.com/sci-ndp/pop-py.git
    cd pop-py
    
  2. Create and activate a virtual environment:

    python3 -m venv .venv
    source .venv/bin/activate
    
  3. Install the package in editable mode:

    pip install -e .
    
  4. Install development dependencies (optional, for testing):

    pip install -r requirements.txt
    

Option 2: Install via pip

Once the package is published on PyPI, you can install it directly using pip:

pip install pointofpresence

Tutorial

For a step-by-step guide on how to use the pointofpresence library, check out our comprehensive tutorial: 10 Minutes for a Point of Presence.

Running Tests

To run the tests, navigate to the project root and execute:

pytest

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/new-feature)
  3. Make your changes and commit (git commit -m 'Add new feature')
  4. Push to the branch (git push origin feature/new-feature)
  5. Open a Pull Reques

License

This project is licensed under the MIT License. See the LICENSE file for details.

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

pointofpresence-0.2.0.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

pointofpresence-0.2.0-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file pointofpresence-0.2.0.tar.gz.

File metadata

  • Download URL: pointofpresence-0.2.0.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pointofpresence-0.2.0.tar.gz
Algorithm Hash digest
SHA256 937a292a0cf1fbf5d4c7d599c00aaee6637d7fa66b1c7562a3d031bbfb05d711
MD5 ce3b72414592e0566a2869219edb475d
BLAKE2b-256 c3689207eba1ec7b85fe6c6b281104c13609229206803e8a788c037623b9ae6d

See more details on using hashes here.

File details

Details for the file pointofpresence-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pointofpresence-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7896e45e33e78379103480a04b4f395aea9222e20b9734b41933e7ece1c3e42a
MD5 226c9f9be67483361f5209e2bd278f3b
BLAKE2b-256 6a33ad8d4e2e74b72867ea44b37a54a2ab668861490cbdba611d0fd896b293b9

See more details on using hashes here.

Supported by

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