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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pt42api_wrapper-1.0.5.tar.gz
  • Upload date:
  • Size: 6.6 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.5.tar.gz
Algorithm Hash digest
SHA256 8f48ac68305f81b39c2f90cc087120a9e88ec6f47e8736649b12fa38e52a5ea6
MD5 d6603cedb1818957c63dd379665f2893
BLAKE2b-256 a5abaf9209f5ecf7779a087e99fd54658d3d9c4d99dca4e9e223f2a842e63880

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pt42api_wrapper-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a6f3f1f5d3588f2e37feed2107ceef4103a3012421aa219768b9d770367da175
MD5 52dfc0121f30e47f09c59d2917e67b54
BLAKE2b-256 f5a53787660d7369909bc8cd112fe31419f49bd3f4463eb0176a05f69771312b

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