Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for python_api_client, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size python_api_client-0.0.1.tar.gz (6.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page