Skip to content

Dessia-tech/dessia_api_client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dessia API Client

Connect your software with dessia platform instances

Contributors Stargazers Issues

Getting Started

pip(3) install dessia_api_client

Usage


from dessia_api_client.users import PlatformUser

# get an api user
# replace with proper credentials
brad = PlatformUser("[email protected]", "brad_pass1!",
                  api_url="https://api.platform.dessia.tech")

# run your tests/scripts
# for eg:
all_jobs_resp = brad.jobs.list_jobs()  # list jobs
brad.jobs.submit_job(object_class="some_class", object_id=5)  # submit new one
active_apps = brad.applications.get_active_applications()  # see active apps ...


For interactive email/password prompt:

brad = PlatformUser(api_url="https://api.platform.dessia.tech")

See the script folder for other examples

Issues

See the open issues for a full list of proposed features (and known issues).

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

License

Distributed under the LGPL License. See LICENSE for more information.

Project Link: https://github.com/Dessia-tech/dessia_api_client