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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pt42api_wrapper-0.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 338b2f0d2906802df09d89fb760c2c295dc4944e6eff3da26a75e56a12fcf4cf
MD5 d2e3f54575c0dc10b9ab921b26dfa733
BLAKE2b-256 f24234f95cc0aaa6e8598b837ced0edbef6f6b4b4067b39b3cb5e8f637e219c4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pt42api_wrapper-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ec2f09884fc0b05866100e4b8d33a3d4bcce40c5172a68dee9204d8124524230
MD5 b97a4ed933046d43e566ef6ebae4e9af
BLAKE2b-256 9f9ef4f5c15c48e60723fc04e3722ce7a86fafdf96dffa19db2abe06dd77e472

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