pyobs-brot 2.0.0.dev1__tar.gz → 2.0.0.dev2__tar.gz

pyobs_brot-2.0.0.dev2/.github/workflows/pypi.yml

@@ -0,0 +1,26 @@
+name: Publish package to PyPI
+on:
+  push:
+    tags:
+    - 'v*'
+jobs:
+  build-n-publish:
+    name: Build and publish package to PyPI
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          python-version: "3.11"
+
+      - name: Build
+        run: uv build
+
+      - name: Publish
+        env:
+          PYPI_TOKEN: ${{ secrets.pypi_password }}
+        run: uv publish --token $PYPI_TOKEN

pyobs_brot-2.0.0.dev2/.github/workflows/ruff.yml

@@ -0,0 +1,23 @@
+name: ruff
+on: push
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          python-version: "3.13"
+
+      - name: Install packages
+        run: uv sync --all-extras --dev
+
+      - name: Run ruff
+        run: uv run ruff check pyobs_brot/

{pyobs_brot-2.0.0.dev1 → pyobs_brot-2.0.0.dev2}/.gitignore

@@ -1,8 +1,5 @@
 # https://github.com/github/gitignore/blob/main/Python.gitignore
 
-*.yaml
-*.yml
-
 #Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

pyobs_brot-2.0.0.dev2/.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 23.7.0
+    hooks:
+      - id: black
+        language_version: python3.11
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.0
+    hooks:
+      - id: ruff

pyobs_brot-2.0.0.dev2/.readthedocs.yml

@@ -0,0 +1,15 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: docs/requirements.txt

{pyobs_brot-2.0.0.dev1 → pyobs_brot-2.0.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyobs-brot
-Version: 2.0.0.dev1
+Version: 2.0.0.dev2
 Summary: pyobs module for BROTlib telescopes
 Author-email: Tim-Oliver Husser <thusser@uni-goettingen.de>, Lukas Melzig <lukas.melzig@stud.uni-goettingen.de>
 License-Expression: MIT

pyobs_brot-2.0.0.dev2/README.md

@@ -0,0 +1,60 @@
+BROTlib module for *pyobs*
+==========================
+
+This is a [pyobs](https://www.pyobs.org) module for telescopes, domes and roll-off roofs controlled via
+[BROTlib](https://pypi.org/project/pybrotlib/) over MQTT.
+
+
+Install *pyobs-brot*
+---------------------
+Clone the repository:
+
+    git clone https://github.com/pyobs/pyobs-brot.git
+    cd pyobs-brot
+
+Install it with [uv](https://docs.astral.sh/uv/):
+
+    uv sync
+
+Alternatively, with plain `venv`/`pip`:
+
+    python3 -m venv .venv
+    source .venv/bin/activate
+    pip install .
+
+
+Configuration
+-------------
+*BrotRaDecTelescope* (or its base class *BrotBaseTelescope*), *BrotDome* and *BrotRoof* all connect to the same
+MQTT broker used by BROTlib:
+
+    host:
+        Hostname of the MQTT broker.
+    name:
+        Name of the BROT device.
+    port:
+        MQTT port (default: 1883).
+
+A basic telescope configuration would look like this:
+
+    class: pyobs_brot.BrotRaDecTelescope
+    name: My telescope
+    host: 1.2.3.4
+    roof: roof
+    dome: dome
+
+    # communication
+    comm:
+      jid: test@example.com
+      password: ***
+
+*BrotDome* and *BrotRoof* follow the same pattern, just with `class: pyobs_brot.BrotDome` respectively
+`class: pyobs_brot.BrotRoof`.
+
+
+Dependencies
+------------
+* [pyobs-core](https://github.com/pyobs/pyobs-core) for the core functionality.
+* [pybrotlib](https://pypi.org/project/pybrotlib/) for communicating with BROT devices.
+* [paho-mqtt](https://pypi.org/project/paho-mqtt/) as the MQTT client used by BROTlib.
+* [Astropy](http://www.astropy.org/) for FITS file handling.

pyobs_brot-2.0.0.dev2/docs/Makefile

@@ -0,0 +1,31 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = pyobs
+SOURCEDIR     = source
+BUILDDIR      = ../.doc-build
+
+#.EXPORT_ALL_VARIABLES:
+
+#PYTHONPATH:=../pyobs-core/:../pyobs-sbig/:../pyobs-fli:../pyobs-weather:../pyobs-archive:${PYTHONPATH}
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+html:
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
+
+livehtml:
+	sphinx-autobuild -b html --watch ../pyobs_brot $(ALLSPHINXOPTS) "$(SOURCEDIR)/" "$(BUILDDIR)/html/"
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+

pyobs_brot-2.0.0.dev2/docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=pyobs
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

pyobs_brot-2.0.0.dev2/docs/requirements.txt

@@ -0,0 +1 @@
+sphinx-rtd-theme

pyobs_brot-2.0.0.dev2/docs/source/conf.py

@@ -0,0 +1,117 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/stable/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../../"))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "pyobs-brot"
+copyright = "2024, Tim-Oliver Husser"
+author = "Tim-Oliver Husser"
+
+# The short X.Y version
+# version = "0.16"
+# The full version, including alpha/beta/rc tags
+# release = "0.16.0"
+
+
+# -- General configuration ---------------------------------------------------
+
+add_module_names = False
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.intersphinx",
+    #'sphinx_autodoc_typehints'
+]
+
+intersphinx_mapping = {"http://docs.python.org/3": None}
+
+# napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
+napoleon_use_param = False
+napoleon_use_ivar = True
+
+# typehints
+# set_type_checking_flag = True
+# autodoc_typehints = "description"
+
+# show c'tor parameters in class only
+autoclass_content = "both"
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# Be a little nitpicky
+nitpicky = True
+nitpick_ignore = []
+
+# intersphinx
+intersphinx_mapping = {
+    "pyobs": ("https://pyobs-core.readthedocs.io/en/latest/", None),
+}
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {
+    "collapse_navigation": False,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
+    "display_version": False,
+    "logo_only": False,
+    "prev_next_buttons_location": "bottom",
+    "titles_only": False,
+    "style_nav_header_background": "#cccccc",
+}
+html_logo = "_static/pyobs.gif"

pyobs_brot-2.0.0.dev2/docs/source/index.rst

@@ -0,0 +1,75 @@
+pyobs-brot
+##########
+
+This is a `pyobs <https://www.pyobs.org>`_ (`documentation <https://docs.pyobs.org>`_) module for telescopes,
+domes and roll-off roofs controlled via `BROTlib <https://pypi.org/project/pybrotlib/>`_ over MQTT.
+
+
+Example configuration
+*********************
+
+This is an example configuration for a telescope::
+
+    class: pyobs_brot.BrotRaDecTelescope
+    host: 1.2.3.4
+    name: My telescope
+    roof: roof
+    dome: dome
+
+    # communication
+    comm:
+      jid: test@example.com
+      password: ***
+
+The dome and roof connect to the same BROT device and MQTT broker::
+
+    class: pyobs_brot.BrotDome
+    host: 1.2.3.4
+    name: My telescope
+
+    # communication
+    comm:
+      jid: test@example.com
+      password: ***
+
+::
+
+    class: pyobs_brot.BrotRoof
+    host: 1.2.3.4
+    name: My telescope
+
+    # communication
+    comm:
+      jid: test@example.com
+      password: ***
+
+
+Available classes
+*****************
+
+:class:`~pyobs_brot.BrotRaDecTelescope` (based on :class:`~pyobs_brot.BrotBaseTelescope`) drives a telescope,
+:class:`~pyobs_brot.BrotDome` a dome, and :class:`~pyobs_brot.BrotRoof` a roll-off roof.
+
+BrotBaseTelescope
+=================
+.. autoclass:: pyobs_brot.BrotBaseTelescope
+   :members:
+   :show-inheritance:
+
+BrotRaDecTelescope
+==================
+.. autoclass:: pyobs_brot.BrotRaDecTelescope
+   :members:
+   :show-inheritance:
+
+BrotDome
+========
+.. autoclass:: pyobs_brot.BrotDome
+   :members:
+   :show-inheritance:
+
+BrotRoof
+========
+.. autoclass:: pyobs_brot.BrotRoof
+   :members:
+   :show-inheritance:

{pyobs_brot-2.0.0.dev1 → pyobs_brot-2.0.0.dev2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyobs-brot"
-version = "2.0.0.dev1"
+version = "2.0.0.dev2"
 description = "pyobs module for BROTlib telescopes"
 authors = [{ name = "Tim-Oliver Husser", email = "thusser@uni-goettingen.de" }, { name = "Lukas Melzig", email = "lukas.melzig@stud.uni-goettingen.de" }]
 requires-python = ">=3.11"

{pyobs_brot-2.0.0.dev1 → pyobs_brot-2.0.0.dev2}/uv.lock

@@ -1783,7 +1783,7 @@ wheels = [
 
 [[package]]
 name = "pyobs-brot"
-version = "2.0.0.dev1"
+version = "2.0.0.dev2"
 source = { editable = "." }
 dependencies = [
     { name = "astropy" },

pyobs_brot-2.0.0.dev1/README.md

@@ -1,3 +0,0 @@
-BROTlib module for *pyobs*
-==========================
-