Skip to content
Python 3 SDK for the oef-core.
Branch: master
Clone or download
engineerkatie Hotfix/alpha 1 (#3)
* Repair damaged alpha release merge
Latest commit 1db8f7a May 1, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docker-images @ b4a7be5 OEF alpha release Apr 30, 2019
docs OEF alpha release Apr 30, 2019
examples OEF alpha release Apr 30, 2019
oef-core-protocol OEF alpha release Apr 30, 2019
oef-sdk-python-image OEF alpha release Apr 30, 2019
oef Hotfix/alpha 1 (#3) May 1, 2019
scripts OEF alpha release Apr 30, 2019
static-files Hotfix/alpha 1 (#3) May 1, 2019
test OEF alpha release Apr 30, 2019
.dockerignore OEF alpha release Apr 30, 2019
.flake8 OEF alpha release Apr 30, 2019
.gitignore OEF alpha release Apr 30, 2019
.gitmodules OEF alpha release Apr 30, 2019
AUTHORS.rst OEF alpha release Apr 30, 2019
CONTRIBUTING.rst OEF alpha release Apr 30, 2019
HISTORY.rst OEF alpha release Apr 30, 2019
Jenkinsfile OEF alpha release Apr 30, 2019
LICENSE
MANIFEST.in OEF alpha release Apr 30, 2019
Makefile OEF alpha release Apr 30, 2019
Pipfile OEF alpha release Apr 30, 2019
Pipfile.lock OEF alpha release Apr 30, 2019
README.md OEF alpha release Apr 30, 2019
setup.py OEF alpha release Apr 30, 2019
tox.ini OEF alpha release Apr 30, 2019

README.md

OEF Python SDK

This is the Python SDK for OEF agent development, allowing:

  • registration of agents and services in the OEF
  • searching for agents and services in the OEF
  • constructing a direct communication channel with another agent

Dependencies

  • Google Protocol Buffers compiler. You can install it in several ways, depending on your platform:

    • On Debian-based (e.g. Ubuntu):

      sudo apt-get install protobuf-compiler
      
    • You can do it manually by checking the release page and by choosing the release for your platform. The name format is protoc-$(VERSION)-$(PLATFORM).zip (e.g. for Windows look at protoc-$(VERSION)-win32.zip).

    • Compile from source.

  • On MacOS

      brew install protobuf
    

Installation

In order to install oef, run:

python setup.py install 

or

python3 setup.py install 

or

python3 setup.py install

Run the tests

To run the tests, you need to clone oef-core repository and build the project. Check that you have installed all the dependencies (see INSTALL.txt):

python scripts/setup_test.py

Finally:

tox -e py3x

Where x depends on your Python version (either 3.5, 3.6 or 3.7).

Documentation

For the documentation we use Sphinx.

  • Install the required packages with Pipenv and activate the shell:

    pipenv install --dev
    pipenv shell
    
  • Then build the docs with:

    cd docs/
    make html
    

And then just open index.html in the build/html folder.

You can’t perform that action at this time.