From b7a0a76e9c1a20302fe705afbb7b9fe6e08a072c Mon Sep 17 00:00:00 2001 From: Pedro Crespo-Valero <32402063+pcrespov@users.noreply.github.com> Date: Tue, 8 Oct 2024 10:41:20 +0200 Subject: [PATCH 1/3] enh doc --- docs/doc_entrypoint.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/docs/doc_entrypoint.md b/docs/doc_entrypoint.md index 596c0680..46f6f74a 100644 --- a/docs/doc_entrypoint.md +++ b/docs/doc_entrypoint.md @@ -4,7 +4,6 @@ [![PyPI - Release](https://img.shields.io/pypi/status/osparc)](https://pypi.org/project/osparc/#history) [![PyPI Downloads](https://img.shields.io/pypi/dm/osparc)](https://pypi.org/project/osparc/) - `osparc` is a Python package that provides tools and functionalities to interact with the o²S²PARC platform. It allows for seamless integration and automation of workflows in simulation science, making it easier to handle simulations and access [o²S²PARC services](https://github.com/ITISFoundation/osparc-simcore) ## Features @@ -21,10 +20,8 @@ You can install `osparc` directly from PyPI: pip install osparc ``` - ## Getting Started with `osparc` - ### API Key/Secret Setup Before interacting with the osparc API, you need to generate an API key-secret pair from your osparc account. Follow the [instructions here](https://docs.osparc.io/#/docs/platform_introduction/user_setup/security_details?id=generating-o%c2%b2s%c2%b2parc-tokens) to create the key and secret. @@ -72,16 +69,13 @@ with ApiClient() as api_client: ### Additional Resources -For more in-depth usage, refer to the following tutorial guides: +For more in-depth usage, refer to the following resources: - [Version 0.5 Documentation](clients/python/docs/v0.5.0/README.md) - [Version 0.6 Documentation](clients/python/docs/v0.6.0/README.md) - +- [Community-Contributed Scripts](https://github.com/topics/osparc-python) + - ✨ [gh:newton1985/osparc_api_example](https://github.com/newton1985/osparc_api_example): A repository containing a "standalone" sample project that illustrates the use of the osparc API ## License This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details. - ---- - -Make sure to replace `your-username` with your actual GitHub username or repository link, and feel free to modify the sections as necessary. From 8161166f4ef3c22ab9bc0d1e52ecfe70a532c9c2 Mon Sep 17 00:00:00 2001 From: Pedro Crespo-Valero <32402063+pcrespov@users.noreply.github.com> Date: Tue, 8 Oct 2024 10:49:55 +0200 Subject: [PATCH 2/3] update structure --- docs/doc_entrypoint.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/doc_entrypoint.md b/docs/doc_entrypoint.md index 46f6f74a..8bf196b6 100644 --- a/docs/doc_entrypoint.md +++ b/docs/doc_entrypoint.md @@ -71,10 +71,13 @@ with ApiClient() as api_client: For more in-depth usage, refer to the following resources: -- [Version 0.5 Documentation](clients/python/docs/v0.5.0/README.md) -- [Version 0.6 Documentation](clients/python/docs/v0.6.0/README.md) +- 📚 Documentation + - [Version 0.6](clients/python/docs/v0.6.0/README.md) + - [Version 0.5](clients/python/docs/v0.5.0/README.md) - [Community-Contributed Scripts](https://github.com/topics/osparc-python) - ✨ [gh:newton1985/osparc_api_example](https://github.com/newton1985/osparc_api_example): A repository containing a "standalone" sample project that illustrates the use of the osparc API +- 🤝 If you want your scripts to appear here, just create a github repository and [tag it with the `osparc-python` topic](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics) to it. + ## License From 0897fd3aa868dea1a73b45ff135d553855af3f31 Mon Sep 17 00:00:00 2001 From: Pedro Crespo-Valero <32402063+pcrespov@users.noreply.github.com> Date: Tue, 8 Oct 2024 10:51:05 +0200 Subject: [PATCH 3/3] imprves tip --- docs/doc_entrypoint.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/doc_entrypoint.md b/docs/doc_entrypoint.md index 8bf196b6..cee13777 100644 --- a/docs/doc_entrypoint.md +++ b/docs/doc_entrypoint.md @@ -76,7 +76,8 @@ For more in-depth usage, refer to the following resources: - [Version 0.5](clients/python/docs/v0.5.0/README.md) - [Community-Contributed Scripts](https://github.com/topics/osparc-python) - ✨ [gh:newton1985/osparc_api_example](https://github.com/newton1985/osparc_api_example): A repository containing a "standalone" sample project that illustrates the use of the osparc API -- 🤝 If you want your scripts to appear here, just create a github repository and [tag it with the `osparc-python` topic](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics) to it. + +>💡 If you want your scripts to be listed here, just create a github repository and [tag it with the `osparc-python` topic](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics). ## License