1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
[](https://badge.fury.io/py/pyodata)
[](https://codecov.io/gh/SAP/python-pyodata)
[](https://api.reuse.software/info/github.com/SAP/python-pyodata)
# Python OData Client - pyodata
Python OData client which provides comfortable Python agnostic
way for communication with OData services.
The goal of this Python module is to hide all OData protocol implementation
details.
## Supported features
- OData V2
## Requirements
- [Python >= 3.9](https://www.python.org/downloads/)
## Download and Installation
Install and update using pip:
```bash
pip install -U pyodata
```
## Configuration
You can start building your OData projects straight away after installing the
Python module without any additional configuration steps needed.
## Limitations
There have been no limitations discovered yet.
## Known Issues
There are no known issues at this time.
## How to obtain support
We accept bug reports, feature requests, questions and comments via [GitHub issues](https://github.com/SAP/python-pyodata/issues)
## Usage
The only thing you need to do is to import the _pyodata_ Python module and
provide an object implementing interface compatible with [Session Object](https://2.python-requests.org/en/master/user/advanced/#session-objects)
for the library [Requests](https://2.python-requests.org/en/master/).
```python
import requests
import pyodata
SERVICE_URL = 'http://services.odata.org/V2/Northwind/Northwind.svc/'
# Create instance of OData client
client = pyodata.Client(SERVICE_URL, requests.Session())
```
Find more sophisticated examples in [The User Guide](docs/usage/README.md).
## Contributing
Please, go through [the Contributing guideline](CONTRIBUTING.md).
### Authoring a patch
Here's an example workflow for a project `PyOData` hosted on Github
Your username is `yourname` and you're submitting a basic bugfix or feature.
* Hit 'fork' on Github, creating e.g. `yourname/PyOData`.
* `git clone git@github.com:yourname/PyOData`
* `git checkout -b foo_the_bars` to create new local branch named foo_the_bars
* Hack, hack, hack
* Run `python3 -m pytest` or `make check`
* `git status`
* `git add`
* `git commit -s -m "Foo the bars"`
* `git push -u origin HEAD` to create foo_the_bars branch in your fork
* Visit your fork at Github and click handy "Pull request" button.
* In the description field, write down issue number (if submitting code fixing
an existing issue) or describe the issue + your fix (if submitting a wholly
new bugfix).
* Hit 'submit'! And please be patient - the maintainers will get to you when
they can.
## License
Copyright (c) 2023 SAP SE or an SAP affiliate company. All rights reserved.
This file is licensed under the Apache Software License, v. 2 except as noted
otherwise in [the LICENSE file](LICENSE)
|
