https://github.com/evbg/evc
evc - Simple client for the EVE Python REST API Framework
https://github.com/evbg/evc
client crud filtering get http mongodb pagination patch post put pypy python python3 rest rest-api simple sorting upsert versioning wrapper
Last synced: 13 days ago
JSON representation
evc - Simple client for the EVE Python REST API Framework
- Host: GitHub
- URL: https://github.com/evbg/evc
- Owner: evbg
- License: mit
- Created: 2016-09-29T18:55:11.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-01-09T10:50:14.000Z (over 6 years ago)
- Last Synced: 2025-10-25T14:44:29.736Z (6 months ago)
- Topics: client, crud, filtering, get, http, mongodb, pagination, patch, post, put, pypy, python, python3, rest, rest-api, simple, sorting, upsert, versioning, wrapper
- Language: Python
- Homepage:
- Size: 52.7 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/py/evc)
[](https://pypi.org/project/evc/)
[](https://github.com/python/black)
# evc
**evc** - a simple wrapper over "requests" HTTP library, which uses json format for transferring, with automatic decoding to the Python dictionary and back when executing HTTP requests to the REST-API server based on the "Eve" framework.
---
*Contents:*
**[Installation](#installation)** |
**[Requirements](#requirements)** |
**[Running the tests](#running-the-tests)** |
**[Example of usage](#example-of-usage)** |
**[Versioning](#versioning)** |
**[Authors](#authors)** |
**[License](#license)**
---
## Getting Started
### Installation
#### From pip
```
pip install --upgrade evc
```
#### Manual install
```
git clone https://github.com/evbg/evc.git
cd evc
python setup.py install
```
#### Installing directly from the [repository](https://github.com/evbg/evc) on GitHub.com
```
pip install git+https://github.com/evbg/evc.git
```
### Requirements
evc requires [requests](https://pypi.org/project/requests/) and [simplejson](https://pypi.org/project/simplejson/) libraries.
## Running the tests
Evc has been tested on the following versions of Python: 2.7, 3.4, 3.5, 3.6, 3.7, pypy, pypy3.
### Integration tests with the Eve framework
#### Prerequisites
To run tests on a localhost, it is necessary that the MongoDB service is started with access control disabled.
#### Running the tests via [tox](https://tox.readthedocs.io/) tool
```
git clone https://github.com/evbg/evc.git
cd evc
tox
```
## Example of usage
The following example shows the use of evc through the Python interactive shell:
### First, run the server "Eve"
```
Python 2.7.5 (default, Mar 9 2014, 22:15:05)
[GCC 4.2.1 Compatible Apple LLVM 5.0 (clang-500.0.68)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> from eve import Eve
>>> settings = {'XML': False, 'JSON': True, 'SERVER_NAME': '127.0.0.1:5555', 'MONGO_DBNAME': 'evc_test'}
>>> settings['RESOURCE_METHODS'] = ['GET', 'POST', 'DELETE']
>>> settings['ITEM_METHODS'] = ['GET', 'PATCH', 'PUT', 'DELETE']
>>> settings['DOMAIN'] = {'persons': {'versioning': True, 'allow_unknown': True, 'schema': {}}}
>>> app = Eve(settings=settings)
>>> app.run()
* Running on http://127.0.0.1:5555/ (Press CTRL+C to quit)
```
### Second, run the client "Evc"
```
Python 2.7.5 (default, Mar 9 2014, 22:15:05)
Type "copyright", "credits" or "license" for more information.
IPython 5.1.0 -- An enhanced Interactive Python.
? -> Introduction and overview of IPython's features.
%quickref -> Quick reference.
help -> Python's own help system.
object? -> Details about 'object', use 'object??' for extra details.
In [1]: from evc import Evc
In [2]: REST = Evc('http://127.0.0.1:5555')
In [3]: type(REST.response)
Out[3]: NoneType
In [4]: REST.get()
Out[4]: {u'_links': {u'child': [{u'href': u'persons', u'title': u'persons'}]}}
In [5]: type(REST.response)
Out[5]: requests.models.Response
In [6]: REST.response.text
Out[6]: u'{"_links": {"child": [{"href": "persons", "title": "persons"}]}}'
In [7]: REST.response.json
Out[7]: >
In [8]: REST.response.json()
Out[8]: {u'_links': {u'child': [{u'href': u'persons', u'title': u'persons'}]}}
In [9]: REST.post('persons', {'name': 'Bob', 'email': 'bob@bobmail.com'})
Out[9]:
{u'_created': u'Tue, 25 Oct 2016 10:46:39 GMT',
u'_etag': u'90d02265b8d7c832247fcaeacf11d1f4bbf8f0bc',
u'_id': u'580f380fa7a3497495d72bd4',
u'_latest_version': 1,
u'_links': {u'self': {u'href': u'persons/580f380fa7a3497495d72bd4',
u'title': u'Person'}},
u'_status': u'OK',
u'_updated': u'Tue, 25 Oct 2016 10:46:39 GMT',
u'_version': 1}
In [10]: REST.patch('persons', '580f380fa7a3497495d72bd4', '90d02265b8d7c832247fcaeacf11d1f4bbf8f0bc', {'name': 'Bob', 'email': 'bob2@bobmail.com'})
Out[10]:
{u'_created': u'Tue, 25 Oct 2016 10:46:39 GMT',
u'_etag': u'50da6d8e759eeb0a32eaf0bd820dcfb729cdf5d9',
u'_id': u'580f380fa7a3497495d72bd4',
u'_latest_version': 2,
u'_links': {u'self': {u'href': u'persons/580f380fa7a3497495d72bd4',
u'title': u'Person'}},
u'_status': u'OK',
u'_updated': u'Tue, 25 Oct 2016 10:48:20 GMT',
u'_version': 2}
In [11]: REST.delete('persons', '580f380fa7a3497495d72bd4', '50da6d8e759eeb0a32eaf0bd820dcfb729cdf5d9')
Out[11]: u''
In [12]: REST.get('persons', '580f380fa7a3497495d72bd4')
Out[12]:
{u'_items': [],
u'_links': {u'parent': {u'href': u'/', u'title': u'home'},
u'self': {u'href': u'persons', u'title': u'persons'}},
u'_meta': {u'max_results': 25, u'page': 1, u'total': 0}}
```
## Versioning
We use [SemVer](http://semver.org/) for versioning.
## Authors
* **Evgeny V. Bogodukhov** - *Initial work* - [evbg](https://github.com/evbg)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details