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_BASE_URL=''
export API_AUTH_URL=''
export API_CLIENT_ID=''
export API_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_BASE_URL'),
    'auth_url': os.environ.get('API_AUTH_URL'),
    'client_id': os.environ.get('API_CLIENT_ID'),
    'client_secret': os.environ.get('API_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.1.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pt42api_wrapper-1.0.1.tar.gz
  • Upload date:
  • Size: 5.7 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.1.tar.gz
Algorithm Hash digest
SHA256 ccfeabb06a6b5cde0f9cb14d9661f64e2f2557c57c370cc9ddf6d6953a4fa7a1
MD5 96ad3c48c96c90d335322ea20e5983fc
BLAKE2b-256 c4be5da3f81ba7a962feb6bb7c9b9d4fb6feb01f794e21d48222934bf6bcf18a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pt42api_wrapper-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 baae42c1d6f0ef331815f999245a7e64cf9a2de7d409d7914088cd47d6ad324c
MD5 86f9fb0cb2e1ebbfcb059b74b6edf142
BLAKE2b-256 ce5cc0bde1740ba9dbfd01555ec32156d485761e95f3ebcb103949ba2d0428e2

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