Skip to main content

Python client for REST api.

Project description

python-api-client
=========================

Python client to connect to REST based api


This is still in its early stages and needs more tests and functionality for PUT, POST, PATCH and DELETE methods


To run the tests
----------------

pip install -r test_requirements.txt

python tests.py


Usage
-----

If you are using Django put the following in to your settings file:

```python
BASE_API_URL = "http://yourdomain.com/api/v2/"
```

If you are not using Django create a file called settings.py in your project and add the line to that.


Models:
```python
from python_api_client.models import Model


class MyModel(Model):
"""
This assumes a url of http://yourdomain.com/api/v2/mymodels/...
if this is not the case you can override

@classmethod
def url(cls):
return 'whatever url you want'

"""
pass
```

Views:
```python
from .models import MyModel


my_models = MyModel.objects.all()

some_of_my_models = MyModel.objects.filter(something='s)

my_model = MyModel.objects.get(pk=2)
my_model.field = 'changed'
my_model.save()

```

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

python_api_client-0.0.1.tar.gz (6.5 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for python_api_client-0.0.1.tar.gz
Algorithm Hash digest
SHA256 5268b25b1e0bb3e0757f363eb687985ffceaa491255bba45657437f2beba049d
MD5 841ab70932d6652275639fad51f74ae4
BLAKE2b-256 4aa4bc63c01fdb1b753e46dd06ca79a5f9d53ba0a019528c7a5fa37c2683cf06

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