PyAstroSALT 0.1.0

API access for the Southern African Large elescope (SALT).

pyastrosalt

Installation

pip install pyastrosalt

Development and deployment

uv is used as the package manager for this project. There are several ways to install uv; see the official [installation instructions]((https://docs.astral.sh/uv/getting-started/installation/).

Managing dependencies

Use uv's add command for adding dependencies. For example:

uv add numpy

To add an optional dependency, use the --optional option. For example, if you want to add pyjwt to the optional group secure:

uv add --optional secure pyjwt

Optional groups are listed in the project.optional-dependencies section of pyproject.toml.

In case the dependency is required for development purposes only, you should use the --dev option. For example, the following will add pytest to the development only group:

uv add --dev pytest

Development only dependency groups are listed in the dependency-groups section of pyproject.toml. They `re not included in the published package.

Documentation

The documentation is generated using Materials for MkDocs and mkdocstrings, and all its files are located in the /docs folder. You can view the generated files by running

mkdocs serve

There also is a pdm script for building the documentation files.

Script	Description
docs	Build the documentation

However, contrary to mkdocs serve, this command does not let you preview the documentation as you write. It is mostly intended for testing purposes.

Deployment

There is a GitHub workflow (publish.xml) for deploying the package to a package repository (such as PyPI). This workflow assumes that the GitHub repository is a trusted publisher. Refer to the PyPI documentation on how to create a PyPI project with a trusted publisher.

in addition, the workflow generates the documentation files and publishes them as a GitHub page (at https://saltastroops.github.io/PyAstroSALT).

To see the deployed documentation, you might have to tweak some settings. Click on Settings in the top menu and then on Page in the sidebar menu. Choose to deploy from a branch, select gh-pages as the branch and / (root) as the folder, and click on the Save button.

The workflow is triggered whenever a release is created for the GitHub repository. The tag for the release must be the package's version number preceded by a "v". For example, if the package version is "1.4.2", the tag must be "v1.4.2". The tag must be for the current commit in the main branch.