diff --git a/README.md b/README.md index 97683d4..4c2f9ee 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # pydase (Python Data Service) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) + `pydase` is a Python library for creating data service servers with integrated web and RPC servers. It's designed to handle the management of data structures, automated tasks, and callbacks, and provides built-in functionality for serving data over different protocols. - [Features](#features) @@ -28,7 +30,7 @@ * Support for additional servers for specific use-cases ## Installation - + Install pydase using [`poetry`](https://python-poetry.org/): ```bash @@ -40,9 +42,10 @@ or `pip`: ```bash pip install git+https://github.com/tiqi-group/pydase.git ``` + ## Usage - + Using `pydase` involves three main steps: defining a `DataService` subclass, running the server, and then connecting to the service either programmatically using `rpyc` or through the web interface. ### Defining a DataService @@ -143,6 +146,7 @@ print(client.voltage) # prints 5.0 ``` In this example, replace `` with the IP address of the machine where the service is running. After establishing a connection, you can interact with the service attributes as if they were local attributes. + ## Understanding Service Persistence @@ -285,7 +289,7 @@ The full documentation provides more detailed information about `pydase`, includ ## Contributing -We welcome contributions! Please see [CONTRIBUTING.md](URL_TO_YOUR_CONTRIBUTING_GUIDELINES) for details on how to contribute. +We welcome contributions! Please see [contributing.md](./docs/about/contributing.md) for details on how to contribute. ## License diff --git a/docs/about/contributing.md b/docs/about/contributing.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/about/license.md b/docs/about/license.md new file mode 100644 index 0000000..96a930e --- /dev/null +++ b/docs/about/license.md @@ -0,0 +1,10 @@ +License +======= +`pydase` is released under the *MIT license*: + +```{.license} +{% +include "../../LICENSE" +comments=false +%} +``` \ No newline at end of file diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/css/extra.css b/docs/css/extra.css new file mode 100644 index 0000000..50a2e17 --- /dev/null +++ b/docs/css/extra.css @@ -0,0 +1,3 @@ +.language-license{ + background-color: #eeffcc !important; +} diff --git a/docs/dev-guide/README.md b/docs/dev-guide/README.md new file mode 100644 index 0000000..e05d64a --- /dev/null +++ b/docs/dev-guide/README.md @@ -0,0 +1,7 @@ +# Developer Guide + +Extending `pydase`. + +--- + +- [API Reference](api.md) \ No newline at end of file diff --git a/docs/dev-guide/api.md b/docs/dev-guide/api.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 0000000..881d450 --- /dev/null +++ b/docs/getting-started.md @@ -0,0 +1,13 @@ +# Installation +{% + include-markdown "../README.md" + start="" + end="" +%} + +# Usage +{% + include-markdown "../README.md" + start="" + end="" +%} \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..96d83c6 --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +{% include-markdown "../README.md" %} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..10533e9 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,41 @@ +site_name: pydase Documentation +repo_url: https://github.com/tiqi-group/pydase +edit_uri: blob/main/docs/ +nav: + - Home: index.md + - Getting Started: getting-started.md + - Developer Guide: + - Developer Guide: dev-guide/README.md + - API Reference: dev-guide/api.md + - About: + - Release Notes: about/release-notes.md + - Contributing: about/contributing.md + - License: about/license.md + +theme: readthedocs + +extra_css: + - css/extra.css + +markdown_extensions: + - smarty + - toc: + permalink: true + baselevel: 4 + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.snippets + - pymdownx.superfences + # - pymdownx.highlight: + # - pymdownx.inlinehilite + + +plugins: + - include-markdown + - search + - mkdocstrings + +watch: + - src/pydase + + \ No newline at end of file