starplot 0.20.6__tar.gz → 0.21.0__tar.gz

{starplot-0.20.6 → starplot-0.21.0}/.dockerignore

@@ -13,6 +13,15 @@ hip_main.dat
 hip8.dat
 
 temp*
+temp/
+.tmp/
+.ruff_cache/
+.pytest_cache/
+
+*.parquet
+*.bsp
+
+build/
 
 # test generated data
 tests/data/actual*.png

{starplot-0.20.6 → starplot-0.21.0}/.github/workflows/docs.yml

@@ -13,12 +13,16 @@ jobs:
 
     steps:
     - uses: actions/checkout@v6
+    - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
 
-    - name: Build Docker image
-      run: make build
+    - name: Install dependencies
+      run: make install env
     
+    - name: Download test fonts
+      run: make download-test-fonts
+      
     - name: Build sky.db
-      run: make db CI=true
+      run: make db setup CI=true
 
     - name: Build Examples
       run: make examples
@@ -26,23 +30,20 @@ jobs:
     - name: Build Tutorial
       run: make tutorial
     
-    - name: Build Data Reference
-      run: make build-doc-data
-
-    - name: Build Docs
-      run: make docs-build
+    - name: Build Documentation
+      run: make docs
 
     - name: Set Version Environment Variable
       run: |
         echo "STARPLOT_VERSION=$(make version)" >> "$GITHUB_ENV"
 
     - id: 'auth'
-      uses: 'google-github-actions/auth@v2'
+      uses: 'google-github-actions/auth@v3'
       with:
         credentials_json: '${{ secrets.GCP_CREDENTIALS }}'
       
     - name: 'Set up Google Cloud SDK'
-      uses: 'google-github-actions/setup-gcloud@v2'
+      uses: 'google-github-actions/setup-gcloud@v3'
       with:
         version: '>= 363.0.0'
 

{starplot-0.20.6 → starplot-0.21.0}/.github/workflows/release.yml

@@ -10,10 +10,14 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
     - uses: actions/checkout@v6
+    - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
 
-    - name: Build Docker Image
-      run: make build
+    - name: Install dependencies
+      run: make install env
     
+    - name: Download test fonts
+      run: make download-test-fonts
+      
     - name: Check Lint
       run: make lint CI=true
     
@@ -21,13 +25,10 @@ jobs:
       run: make format CI=true ARGS=--check
     
     - name: Build sky.db
-      run: make db CI=true
+      run: make db setup CI=true
 
     - name: Run Tests
-      run: make test CI=true
-    
-    - name: Check Image Hashes
-      run: make check-hashes CI=true
+      run: make test check-hashes CI=true
     
     - name: Build
       run: make flit-build

starplot-0.21.0/.github/workflows/test.yml

@@ -0,0 +1,82 @@
+name: Run Tests
+
+on:
+  workflow_dispatch:
+  pull_request:
+    types: [opened, reopened, synchronize]
+    branches:
+      - main
+      - develop
+  schedule:
+        - cron: '0 12 * * *' # 1200 UTC = 0500 PT
+
+jobs:
+  test-lint-build:
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: 'read'
+      id-token: 'write'
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13', '3.14']
+    steps:
+    - uses: actions/checkout@v6
+    - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+    - name: Install dependencies
+      run: make install env
+    - name: Download test fonts
+      run: make download-test-fonts
+    - name: Build sky.db
+      run: make db setup CI=true
+    - name: Check Lint
+      run: make lint CI=true
+    - name: Check Format
+      run: make format CI=true ARGS=--check
+    - name: Run Tests
+      id: run-tests
+      run: make test-python-version PYTHON_VERSION=${{ matrix.python-version }} CI=true
+    - name: Run hash checks
+      id: run-hash-checks
+      run: make check-hashes-python-version PYTHON_VERSION=${{ matrix.python-version }} CI=true
+    - name: Build examples
+      if: always()
+      run: make examples
+    - name: Build tutorial
+      if: always()
+      run: make tutorial
+    - name: Build docs
+      if: always()
+      run: make docs
+    - name: Set Short SHA
+      if: always()
+      run: echo "SHORT_SHA=$(git rev-parse --short HEAD)" >> "$GITHUB_ENV"
+    - id: 'auth'
+      if: always()
+      uses: 'google-github-actions/auth@v3'
+      with:
+        credentials_json: '${{ secrets.GCP_CREDENTIALS }}'
+    - name: 'Set up Google Cloud SDK'
+      if: always()
+      uses: 'google-github-actions/setup-gcloud@v3'
+      with:
+        version: '>= 363.0.0'
+    - name: 'Upload docs on failure'
+      if: always()
+      run: 'gsutil -m rsync -R -d site gs://archives.starplot.dev/test-runs/$SHORT_SHA/${{ matrix.python-version }}/docs/'
+    - name: 'Upload hash check results on failure'
+      if: always()
+      run: |
+        gsutil cp hash_checks/results.html gs://archives.starplot.dev/test-runs/$SHORT_SHA/${{ matrix.python-version }}/hash-checks/results.html
+        gsutil -m rsync -r hash_checks/data gs://archives.starplot.dev/test-runs/$SHORT_SHA/${{ matrix.python-version }}/hash-checks/data/
+    - name: 'Print results URLs'
+      if: always()
+      run: |
+        BASE="https://archives.starplot.dev/test-runs/$SHORT_SHA/${{ matrix.python-version }}"
+        echo "docs: $BASE/docs/index.html"
+        echo "hash checks: $BASE/hash-checks/results.html"
+        echo "### Test run artifacts (Python ${{ matrix.python-version }})" >> "$GITHUB_STEP_SUMMARY"
+        echo "- [docs]($BASE/docs/index.html)" >> "$GITHUB_STEP_SUMMARY"
+        echo "- [hash checks]($BASE/hash-checks/results.html)" >> "$GITHUB_STEP_SUMMARY"
+    - name: Build PIP Package
+      run: make flit-build

{starplot-0.20.6 → starplot-0.21.0}/.gitignore

@@ -1,11 +1,6 @@
-# scratchpad for local development
-scripts/scratchpad.py
-
 .claude/
 
-
-.env-backup
-e2e/
+__marimo__/
 
 # astronomy data
 *.bsp
@@ -17,46 +12,52 @@ duckdb-extensions
 # Sky Object Database
 # ignore this because it's large and created on release
 sky.db
-*.parquet
 gaia*/
 
-# Catalogs
+# Data Catalogs
 *.parquet
+*.csv.gz
 
 # Data Folder
+data/fonts/*
 data/build/*
 !data/build/.keep
-data/fonts/*
-
-# Big Sky Catalog
-# we ignore this because of its size (50+ MB)
-bigsky.*.csv.gz
-bigsky*.parquet
 
+# Hash check results
 hash_checks/data/*.png
 hash_checks/results.html
 
+# E2E test results
+e2e/actual/
+
+# local development scripts etc
+/plots/
+/claude/
 .tmp/
-temp*
+scripts/temp*
 temp.py
 temp/
-# raw/
 scripts/temp/
-plots/
+scripts/scratchpad.py
 scripts/__marimo__/
 
-# Documentation Generated Files
+# Documentation - Generated Files
 examples/*.png
+examples/*.svg
 examples/*.jpg
 examples/*.svg
 docs/images/examples/*.png
+docs/images/examples/*.svg
 docs/images/examples/*.jpg
 docs/images/examples/*.svg
+docs/images/reference/*.png
+docs/images/reference/*.svg
+docs/images/reference/*.jpg
+docs/images/reference/*.html
 tutorial/*.png
 tutorial/*.svg
 docs/images/tutorial/*.png
 docs/images/tutorial/*.svg
-docs/images/reference/*.*
 docs/data/*.json
 
 # Profiling files
@@ -155,7 +156,7 @@ ipython_config.py
 __pypackages__/
 
 # Environments
-.env
+.env*
 .venv
 env/
 venv/

{starplot-0.20.6 → starplot-0.21.0}/CITATION.cff

@@ -20,5 +20,5 @@ keywords:
   - graphs
   - plotting
 license: MIT
-version: 0.20.6
-date-released: '2026-09-17'
+version: 0.21.0
+date-released: '2026-09-27'

starplot-0.21.0/CLAUDE.md

@@ -0,0 +1,46 @@
+## Project
+Starplot is a Python library for creating star charts and maps of the sky.
+
+## Important Dependencies
+- Python
+- pyproj
+- skyfield
+- shapely
+- pydantic
+- astropy
+- ibis-framework
+- fonttools
+- cairosvg
+
+## Structure
+- `src/` — All source code for the distributed Starplot library
+- `tests/` — All unit tests
+- `hash_checks/` — Image hash tests that confirm plots are created correctly
+- `examples/` — Example code for various plots, used on the documentation website
+- `tutorial/` - Code for the tutorial, used on the documentation website
+- `docs/` — Documentation files (using Zensical for building)
+- `data/` - Raw data for star names and translations
+- `plots/` - Scratch code for local development
+
+## Commands
+- Test: `make test`
+- Format: `make format`
+- Lint: `make lint`
+
+## Verification
+After every change, run in this order:
+1. [Test command] — fix failing tests if they're failing because of your change
+2. [Format command] - fix formatting
+3. [Lint command] — fix lint errors
+DO NOT run the hash checks unless specifically told to do so
+
+## Conventions
+- When creating plots for research or investigating an issue:
+    - Put the source code in the `claude/` directory 
+    - Put the output of the final plot in `claude/output/`
+    - Prefer SVG output, unless told otherwise
+- Avoid comments that only describe what the code does (unless it's a docstring for a function)
+- When it's not obvious why code does something a certain way, then a comment explaining _why_ should be added
+- When writing tests, avoid mocking things when possible. 
+- HTTP requests should always be mocked in tests, but their mocked response should mimic the data structure of the real response
+- When finishing a code task, include a bulleted list of files you modified and make them links to open in VSCode

{starplot-0.20.6 → starplot-0.21.0}/CONTRIBUTING.md

@@ -18,33 +18,34 @@ If you're new to contributing to open source projects or git in general, then he
 2. Clone the repository to your local machine
 3. Create a new branch on your forked version
 4. Commit changes to your fork's branch
-5. Open a pull request from your fork's branch into Starplot's `develop` branch ([here's an example](https://github.com/steveberardi/starplot/pull/89))
+5. Open a pull request from your fork's branch into Starplot's `main` branch ([here's an example](https://github.com/steveberardi/starplot/pull/89))
 6. Wait for someone to review your PR (usually a few days to a week)
 
 
 ## Getting Started
 
-The repository has a few helpers for developing locally:
-
-- `Makefile` with commands for various tasks (running tests, etc)
-- `Dockerfile` for running Starplot in an isolated environment
-- `scripts/scratchpad.py` for running scratch code
+The repository has a `Makefile` with commands for various tasks (installing dependencies, running tests, etc). These should make it easier to get things running.
 
 When you're new to a codebase it's usually good to start by just checking out the code, building the development environment and running the tests. So, here's how to do that:
 
-1. `make build` will build a Docker container with Starplot's source code mounted as a volume and will also install all of Starplot's dependencies (e.g. GDAL, Matplotlib, Skyfield, etc) - _this requires Docker to be installed first_
-2. `make test` will run all the unit tests inside the Docker container
-3. `make check-hashes` will run all the image hash checks and create an HTML file with the results (more on this below)
+0. Install system dependencies:
+    - **uv**: `pip install uv` if you don't already have `uv` installed
+    - **cairo**: [See Starplot install docs for details](https://starplot.dev/installation/)
+1. `make install` will install all dependencies (including development requirements) in a local virtual environment
+2. `make dev` will build the object name databases, download object catalogs, and download required fonts
+3. `make test` will run all the unit tests inside the virtual environment
+4. `make check-hashes` will run all the image hash checks and create an HTML file with the results (more on this below)
 
 There are also a few other `make` commands that are useful when developing locally:
 
 - `make marimo` will run a marimo edit session with `scripts/marimo.py` so you can quickly test out code and see its results in a [marimo notebook](https://marimo.io/)
-- `make scratchpad` will run `scripts/scratchpad.py` inside the docker container. The `scratchpad.py` file is not checked in to the repo (so you'll have to create it on your machine), but it's a way to run code with the current state of Starplot on your machine -- very helpful when trying things out.
+- `make scratchpad` will run `scripts/scratchpad.py`. The `scratchpad.py` file is not checked in to the repo (so you'll have to create it on your machine), but it's a way to run code with the current state of Starplot on your machine -- very helpful when trying things out.
 - `make profile` will run `scripts/scratchpad.py` through Python's [built-in profiler](https://docs.python.org/3/library/profile.html#module-cProfile) and then start a [snakeviz](https://jiffyclub.github.io/snakeviz/) webserver locally to let you explore the call stack and see runtimes of everything. This can be very helpful when trying to find bottlenecks in code.
-- `make shell` will open a Python shell on the Docker container
 - `make format` will format the code with our standard formatter
 - `make lint` will check for lint (e.g. unused imports) and `make lint ARGS=--fix` can usually autofix things
 - `make docs-serve` will build the docs and start a local webserver for them
+- `make examples` and `make tutorial` will build images for those sections of the documentation
+- `make docs` will build all the other documentation assets and clear the cache
 
 ## Tests
 

starplot-0.21.0/Dockerfile

@@ -0,0 +1,29 @@
+ARG PYTHON_VERSION=3.12.14
+FROM python:${PYTHON_VERSION}-trixie
+
+WORKDIR /starplot
+
+COPY . .
+
+ENV UV_PROJECT_ENVIRONMENT=/usr/local
+ENV STARPLOT_DATA_PATH=/starplot/data
+ENV PYTHONPATH=/starplot/src/
+
+# Install Cairo (for PNG exports)
+RUN apt update && apt install libcairo2-dev
+
+RUN pip install uv
+RUN uv sync --all-groups --all-extras
+
+RUN git config --global --add safe.directory /starplot
+
+# Build database
+RUN uv run data/scripts/db.py
+
+# Install fonts etc
+RUN uv run starplot setup
+
+# Install fonts used in tests
+RUN uv run scripts/download_test_fonts.py
+
+CMD ["bash", "-c", "uv run pytest ."]

starplot-0.21.0/Makefile

@@ -0,0 +1,177 @@
+PYTHON_VERSION=3.12
+
+ifeq ($(CI), true)
+ DR_ARGS=-e FLIT_USERNAME -e FLIT_PASSWORD
+else
+ DR_ARGS=-it 
+ #--env-file ./.env
+endif
+
+DOTENV=--env-file $(shell pwd)/.env
+DOCKER_RUN=docker run --rm $(DR_ARGS) -v $(shell pwd):/starplot starplot-dev bash -c
+
+DOCKER_BUILD_PYTHON=docker build -t starplot-$(PYTHON_VERSION) $(DOCKER_BUILD_ARGS) --build-arg="PYTHON_VERSION=$(PYTHON_VERSION)" .
+DOCKER_RUN_PYTHON_TEST=docker run --rm $(DR_ARGS) starplot-$(PYTHON_VERSION)
+
+export PYTHONPATH=./src/
+
+# ------------------------------------------------------------------
+install:
+	uv sync --all-groups --all-extras
+
+build: PYTHON_VERSION=3.12.12
+build: DOCKER_BUILD_ARGS=-t starplot-dev
+build:
+	touch -a .env
+	$(DOCKER_BUILD_PYTHON)
+
+env:
+	test -f .env || echo "STARPLOT_DATA_PATH=$(CURDIR)/data/" > .env
+
+lint:
+	uv run $(DOTENV) ruff check $(ARGS) src/ tests/ hash_checks/ 
+
+format:
+	uv run $(DOTENV) ruff format $(ARGS) src/ tests/ scripts/ examples/ hash_checks/ tutorial/ data/
+
+test:
+	uv run $(DOTENV) pytest $(ARGS) --cov=src/ --cov-report=term --cov-report=html tests/
+
+test-python-version:
+	uv run $(DOTENV) --python $(PYTHON_VERSION) --isolated pytest tests/
+
+check-hashes:
+	rm -f hash_checks/data/*.png
+	uv run $(DOTENV) python hash_checks/hashio.py check
+
+check-hashes-python-version:
+	rm -f hash_checks/data/*.png
+	uv run $(DOTENV) --python $(PYTHON_VERSION) hash_checks/hashio.py check
+
+lock-hashes:
+	uv run $(DOTENV) python hash_checks/hashio.py lock
+
+e2e:
+	find e2e/actual -name '*.svg' -delete 2>/dev/null || true
+	uv run $(DOTENV) --python $(PYTHON_VERSION) e2e/run.py
+
+e2e-lock:
+	find e2e/actual -name '*.svg' -delete 2>/dev/null || true
+	uv run $(DOTENV) python e2e/run.py --lock
+
+shell:
+	uv run $(DOTENV) ipython
+
+marimo: DR_ARGS=-it -p 9009:9009
+marimo:
+	uv run $(DOTENV) marimo edit scripts/marimo.py --no-token  --host 0.0.0.0 --port 9009
+
+examples:
+	cd examples && rm -f *.png && rm -f *.jpg && uv run $(DOTENV) examples.py
+
+tutorial:
+	cd tutorial && uv run $(DOTENV) build.py
+
+profile: DR_ARGS=-it -p 8081:8081
+profile:
+	$(DOCKER_RUN) "python -m cProfile -o temp/results.prof scripts/scratchpad.py && \
+	snakeviz -s -p 8081 -H 0.0.0.0 temp/results.prof"
+
+db: 
+	uv run $(DOTENV) data/scripts/db.py
+
+build-data-clean:
+	mkdir -p data/build
+	rm -rf data/build/*
+
+build-star-designations:
+	uv run $(DOTENV) data/scripts/star_designations.py
+
+version:
+	uv run $(DOTENV) python -c 'import starplot as sp; print(sp.__version__)'
+
+setup:
+	uv run $(DOTENV) starplot setup
+
+download-test-fonts:
+	uv run $(DOTENV) scripts/download_test_fonts.py
+
+dev: env db setup download-test-fonts
+
+# ------------------------------------------------------------------
+# Python version testing
+# ------------------------------------------------------------------
+test-3.10: PYTHON_VERSION=3.10.21
+test-3.10:
+	$(DOCKER_BUILD_PYTHON)
+	$(DOCKER_RUN_PYTHON_TEST)
+
+test-3.11: PYTHON_VERSION=3.11.16
+test-3.11:
+	$(DOCKER_BUILD_PYTHON)
+	$(DOCKER_RUN_PYTHON_TEST)
+
+test-3.12: PYTHON_VERSION=3.12.14
+test-3.12:
+	$(DOCKER_BUILD_PYTHON)
+	$(DOCKER_RUN_PYTHON_TEST)
+
+test-3.13: PYTHON_VERSION=3.13.15
+test-3.13:
+	$(DOCKER_BUILD_PYTHON)
+	$(DOCKER_RUN_PYTHON_TEST)
+
+# there are warnings with 3.14, but tests/checks pass
+# needs more investigation
+test-3.14: PYTHON_VERSION=3.14.7
+test-3.14:
+	$(DOCKER_BUILD_PYTHON)
+	$(DOCKER_RUN_PYTHON_TEST)
+
+# ------------------------------------------------------------------
+# Docs
+docs-serve:
+	uv run $(DOTENV) zensical serve
+
+docs-build:
+	uv run $(DOTENV) zensical build -c
+
+docs-references:
+	uv run $(DOTENV) docs/scripts/data.py
+	uv run $(DOTENV) docs/scripts/markers.py
+	uv run $(DOTENV) docs/scripts/gradients.py
+	uv run $(DOTENV) docs/scripts/projections.py
+	uv run $(DOTENV) docs/scripts/projection_list.py
+	uv run $(DOTENV) docs/scripts/style_explorer.py
+
+docs: docs-references docs-build
+
+
+# ------------------------------------------------------------------
+# PyPi - build & publish
+flit-build:
+	uv run $(DOTENV) flit build --no-use-vcs
+
+flit-publish:
+	uv run $(DOTENV) flit publish
+
+flit-install:
+	FLIT_ROOT_INSTALL=1 flit install
+
+# ------------------------------------------------------------------
+# Utils
+scripts:
+	uv run $(DOTENV) python ./scripts/$(SCRIPT).py
+
+list-fonts:
+	uv run $(DOTENV) python ./scripts/list_fonts.py
+
+clean:
+	rm -rf __pycache__
+	rm -rf venv
+	rm -rf dist
+	rm -rf site
+	rm -rf htmlcov
+	rm -f tests/data/*.png
+
+.PHONY: build test shell flit-build flit-publish clean ephemeris examples scripts tutorial list-fonts e2e