Skip to content

Latest commit

 

History

History
95 lines (64 loc) · 3.13 KB

README.md

File metadata and controls

95 lines (64 loc) · 3.13 KB
Raw

Build Status Lint Status PyPI version codecov REUSE status

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

Download and Installation

Install and update using pip:

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

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 for the library Requests.

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.

Contributing

Please, go through the Contributing guideline.

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 [email protected]: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