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.8.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pt42api_wrapper-1.0.8.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.8.tar.gz
Algorithm Hash digest
SHA256 ccd9a1214493d94cb7a137a3a8184198e9cd61ba0b00ba00ae1a4a6e2afcab96
MD5 fd1d6f1e3d2e453184ca7232c0100f12
BLAKE2b-256 4238aac9bdb32bdfe3f24905e948892b947cff4c509f76bad6ef3c847e44f008

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pt42api_wrapper-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 8d24492f6b5d8c0c00e3b0f0c0fb1b0de34de88bda87d1ccbf05613818e53b2d
MD5 1c62ad7b687122a77af7cd3375cdce55
BLAKE2b-256 098b29d9a55af455577aa5fe6524d3a11fc099afa73e610abf455614590a523c

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