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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pt42api_wrapper-1.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 e2ed3d75bb17090aa3cb32ab49e027b612f1c1abbc72d94cf0be652d6b3857f3
MD5 430d1500463c030f2af89cde0fcc3dbf
BLAKE2b-256 ff9fcac836d5d035d9405af84d7cbf993a67c85948d14d0791554ecf823a52e4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pt42api_wrapper-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bb826d45dd02644bbb362d380a289fd3f76e77819a7cc9783ef801b86e9be33b
MD5 73a79d9a6a3aea6222c39286fde508c6
BLAKE2b-256 8c42f8f0e7d9caa1e00ea39ceda88525fb3572c52c6ba9fec1085ff6cf4da663

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