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=''
export SENTRY_DSN=''
  • 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'),
    'sentry_dsn': os.environ.get('SENTRY_DSN')
}
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.3.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

pt42api_wrapper-1.0.3-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pt42api_wrapper-1.0.3.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.12

File hashes

Hashes for pt42api_wrapper-1.0.3.tar.gz
Algorithm Hash digest
SHA256 42b6e988e10894efd1e8fd6402ded712c88ca04570b4a4dc91256bdd17cccd5f
MD5 6b0f37e5051f1f00a985812349f73f64
BLAKE2b-256 3df3d2c978e8e3a8e29d8e933c8edaa693f6c03f439ce0feed82e5e15832fe84

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pt42api_wrapper-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f32eeb9d9dc4f5dc202d06632e0063c576eb63fd31ed792471da9a1460da1ad7
MD5 8417f2ec56efe289a814edd850dd5fb5
BLAKE2b-256 09b133f2fa9aae5eca42703729f44c64b03fdd66786ffcd3f68fc450ae19bfbd

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