Skip to content

Commit

Permalink
📝 doc: new references to external resources (#190)
Browse files Browse the repository at this point in the history
  • Loading branch information
pcrespov authored Oct 8, 2024
1 parent 7cbf7a1 commit 8c38544
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions docs/doc_entrypoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -72,16 +69,17 @@ 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)
- 📚 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 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

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.

0 comments on commit 8c38544

Please sign in to comment.