SDK for OEF Agent development.
Project description
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
Installing for Use
This system can be installed using pip3.
pip3 install fetch-oef
To install it from repository files
python3 setup.py install
Development Environment
This is for anyone who wants to do development work on the code. It is not necessary for using the Fetch.AI OEF system.
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 atprotoc-$(VERSION)-win32.zip
).
-
-
On MacOS
brew install protobuf
Installation
In order to install oef
, run:
python3 scripts/generate_static_files.py
this will compile proto files and setup imports, then
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):
python3 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.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.