Skip to main content

Gamium Client Python

Gamium Client Python is located in the client/python/gamium folder from the source root. This project was organized through poetry.

Package Import​

Requirements​

  • Python 3.9 or later

Install​

Open Python project​

You need a python project. If there is no python project, please use the sample client project.
or you can use your python project.

Find local source code path​

Clone the project on GitHub to local. The Gamium Client TypeScript is located in the client/python/gamium folder from the source root.

$ git clone https://github.com/dogu-team/gamium.git
$ cd client/python/gamium
$ pwd

Please remember the path output from pwd. This path is {gamium_client_python_local_path} which will be shown below.

Add the package to your project​

You can import python package through PYTHONPATH environment variable. Add pwd output above to PYTHONPATH environment variable.

export PYTHONPATH={gamium_client_python_local_path}:$PYTHONPATH

Build and Run​

  • Refer to Write Test Script documentation to import gamium and write the desired script.
  • And run the python script you wrote.

Generate API documentation​

  • API documentation can be generated via {gamium-repo}/utils/docs-api-gen. Go to gamium-repo in the shell and run the command below.
cd docs-api-gen
yarn
yarn run docs:python