demo-jinko-api-cookbook

A light demonstration of Jinko API feature based on a Jupyter Notebook.

Quick start

This project relies on poetry to manage dependency, but any valid jupyter-lab environnement will work.

1. Join jinko.ai, create or choose a project.
2. Register an "Editor" API token from the project settings
3. Copy .envrc.sample to .envrc then edit the values there:
   • JINKO_API_KEY: The API token you created before at step 2
   • JINKO_PROJECT_ID: You'll find it in the project url (a long UUID)
   • JINKO_BASE_URL: Keep the default value.
4. Source the environnement file with source .envrc (we recommend the use of direnv)
5. Run Jupyter Lab

   # Source environnement variable. See too https://direnv.net/ 
   source .envrc
   
   # This is only required once (or when the project is updated)
   poetry install 
   
   # Start Jupyter lab to view & play with the notebooks
   poetry run jupyter-lab

This project relies on poetry to manage dependency, but any other dependency manager may be used.

References

• Jinko Homepage - Join Jinko, log in to your account.
• Jinko API Documentation (alpha) - API Reference, tutorials, cookbooks and format documentation.
• Jinkommunity - End-user documentation, knowledge base, release notes and resources.

---

Jinko is a product of Nova In Silico