Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates #27

Open
sequoiap opened this issue Feb 14, 2022 · 0 comments
Open

Documentation updates #27

sequoiap opened this issue Feb 14, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@sequoiap
Copy link
Collaborator

A few things that need to be documented:

  1. Note how user drivers can be used with PyroLab without being added to the library itself; as long as Python can find the module within its environment, and it inherits from the appropriate PyroLab objects, it can be hosted by the daemon.
  2. Create an example of a simple server that just provides a couple of sample services.
  3. A simple nameserver example, include autoclean functionality.
  4. Examples of how to setup and use lockable services.
  5. How autoconnect works.
  6. Configuration files for autolaunching services.
  7. How to implement your own driver, how to contribute it to PyroLab.
  8. When writing autoconnect, account for the fact that other devices may have already connected and PyroLab doesn't need to reconnect to the hardware. If already open, continue using the same connection.
  9. If external connections are failing, is your service being hosted on "localhost" or on "public"?
  10. Note that all attributes on Pyro-compatible objects should be implemented as properties in order to be accessed remotely.
@sequoiap sequoiap added the documentation Improvements or additions to documentation label Feb 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant