Metadata-Version: 2.4
Name: cambium-astro
Version: 0.1.0
Summary: Astronomy-related stages for Cambium
License-Expression: MIT
License-File: LICENSE
Author: Sidrat Research
Author-email: info@sidratresearch.com
Requires-Python: >=3.11,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: astropy (>=8.0.1,<9.0.0)
Requires-Dist: cambium (>=0.6.0)
Requires-Dist: matplotlib (>=3.11.1,<4.0.0)
Description-Content-Type: text/markdown

# Astronomy Tools for Cambium

This package provides astronomy-specific tooling for the static site generator [Cambium](https://github.com/sidratresearch/cambium).

> [!WARNING]
> This package is under active development. Provided functionality may be incomplete and is subject to major changes.

Currently `cambium-astro` includes the `PreviewFITS` stage. Much like the built-in `PreviewCSV` stage, `PreviewFITS` replaces markdown links that point at FITS files with links to new webpages which show a preview of the content (as well as a download link to the original file!).

Try it out with one of the following methods:

- Install this package, and run `cambium-astro` in place of the regular `cambium` command.
  - This method is only recommended for trying out Cambium Astro, as it cannot be combined with any other Cambium packages
- Edit your Cambium configuration file to include `cambium_astro` in the `extensions` and `cambium_astro.PreviewFITS` in the stages.
  - If you do not have a configuration file, run `cambium --dump-default-config` to display the full default configuration, and make the above changes.
  - Note that you do not need to keep all of the configuration keys - only the ones changed from their default values.

```yaml
# Sample configuration to run Cambium with Cambium Astro
# Do not copy this configuration!
# Cambium is fast-changing and the default stages listed here may be out of date
# Create your own configuration file with `cambium --dump-default-config`

stages:
  - PreviewCSV
  - cambium_astro.PreviewFITS
  - IdentifyMetadata
  - WriteReports
  - TransformMarkdown
  - TemplateMarkdown
  - EnsureIndexPages
  - PagefindSearch
  - CheckLinks

extensions:
  - cambium_astro
```

