Skip to content

Commit 8c38544

Browse files
authored
πŸ“ doc: new references to external resources (#190)
1 parent 7cbf7a1 commit 8c38544

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

β€Ždocs/doc_entrypoint.mdβ€Ž

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
[![PyPI - Release](https://img.shields.io/pypi/status/osparc)](https://pypi.org/project/osparc/#history)
55
[![PyPI Downloads](https://img.shields.io/pypi/dm/osparc)](https://pypi.org/project/osparc/)
66

7-
87
`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)
98

109
## Features
@@ -21,10 +20,8 @@ You can install `osparc` directly from PyPI:
2120
pip install osparc
2221
```
2322

24-
2523
## Getting Started with `osparc`
2624

27-
2825
### API Key/Secret Setup
2926

3027
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,17 @@ with ApiClient() as api_client:
7269

7370
### Additional Resources
7471

75-
For more in-depth usage, refer to the following tutorial guides:
72+
For more in-depth usage, refer to the following resources:
7673

77-
- [Version 0.5 Documentation](clients/python/docs/v0.5.0/README.md)
78-
- [Version 0.6 Documentation](clients/python/docs/v0.6.0/README.md)
74+
- πŸ“š Documentation
75+
- [Version 0.6](clients/python/docs/v0.6.0/README.md)
76+
- [Version 0.5](clients/python/docs/v0.5.0/README.md)
77+
- [Community-Contributed Scripts](https://github.com/topics/osparc-python)
78+
- ✨ [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
79+
80+
>πŸ’‘ 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).
7981
8082

8183
## License
8284

8385
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
84-
85-
---
86-
87-
Make sure to replace `your-username` with your actual GitHub username or repository link, and feel free to modify the sections as necessary.

0 commit comments

Comments
Β (0)