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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pt42api_wrapper-0.0.1.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.1.tar.gz
Algorithm Hash digest
SHA256 dfcbc21c5a5769a499e4eb9cbb4b9c642a3d4a30b97a2cc87fc66668e793d393
MD5 e416de7617b1a295d069ab2ae05aa416
BLAKE2b-256 c1c06a9f0d658988954c8e5d031bbe692f02236ea624081709963fd154b4a661

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pt42api_wrapper-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ec1335bbe1a88e7bca1d0b23628aaedcc36e31578af42fbd23f4f94c50f1dcfd
MD5 c9680b8e78c0cb85b2d99aa9445e7f2c
BLAKE2b-256 f77b1b01d9787fb1c5e8c2ca2823d68774aed8ec25f93be0a6618f680bc21862

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