Skip to main content

A python package that simplifies the process of making API requests to 42 Portugal's API.

Project description

pt42api_wrapper

A python package that simplifies the process of making API requests to 42 Portugal's API. With this package, developers can quickly and easily access the API's functionality, without having to deal with the complexities of working directly with it.

How to install

pip install pt42api-wrapper

Making a simple request

  • Have a .env file that looks like this:
export API_ENDPOINT=''
export AUTH_URL=''
export CLIENT_ID=''
export CLIENT_SECRET=''
  • Use the following code to make a simple request:
import pt42api_wrapper as pt42api

api = pt42api.ApiWrapper()
api.get(url='campus/')

Using in Django Projects

# settings.py
...
PT42API_WRAPPER = {
    'base_url': os.environ.get('API_ENDPOINT'),
    'auth_url': os.environ.get('AUTH_URL'),
    'client_id': os.environ.get('CLIENT_ID'),
    'client_secret': os.environ.get('CLIENT_SECRET'),
}
from django.conf import settings

import pt42api_wrapper as pt42api

(...)

api = pt42api.ApiWrapper(**settings.PT42API_WRAPPER)
url = f'{self.request_url}{data.get("id")}/'
response = api.delete(url, data)
return http.JsonResponse(response.json(), status=response.status_code)

(...)

Configure Api log level

from pt42-wrapper import ApiWrapper

(...)

api = ApiWrapper(log_level=logging.DEBUG)

(...)

Running tests

python3 tests.py

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

pt42api_wrapper-1.0.7.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

pt42api_wrapper-1.0.7-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file pt42api_wrapper-1.0.7.tar.gz.

File metadata

  • Download URL: pt42api_wrapper-1.0.7.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for pt42api_wrapper-1.0.7.tar.gz
Algorithm Hash digest
SHA256 83d9a481288e74c545179f8349fa3d283563e0b9035cb9ed26589f3cde11a446
MD5 e22450d7bc4cb2b77107907cc815f019
BLAKE2b-256 d01fbd8159abd6fdb032bca8eb4d59b823ee9a294e25cb42f76c4b3e0d5abfc6

See more details on using hashes here.

File details

Details for the file pt42api_wrapper-1.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for pt42api_wrapper-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 ef34ed11729c1466ed56b8b7904f6191806707457b9a31d61e0f4c5b2149fb16
MD5 35eb1b32cc9ddee1fc5a6d77daab856e
BLAKE2b-256 644c7f1e299bb66d0be74f5b15801258cd36e3664169a611b6de10c709915faf

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