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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pt42api_wrapper-0.0.3.tar.gz
Algorithm Hash digest
SHA256 c7366de14bc17a5f5313865f404a8a6506ab2c15c02ab76436e0a0baa7fe5a9e
MD5 2b40d560a0519499fbebbd24b164128e
BLAKE2b-256 b9df891a7f3d7b68558c9c242f7995854ee2b844601e14830791ab02d424458e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pt42api_wrapper-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4d1d7c2a69c61855e7f58626b4abe9d10c0762354ca535a1e96003c383dab645
MD5 9241dceb288180be7097f967ef72e333
BLAKE2b-256 fb5be04e93e719e6678c51a763384938f123a272830d58a25cdde27ea7095b8a

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