v0.13.0 (#120)

Author: steveberardi

.github/workflows/test.yml

@@ -49,3 +49,10 @@ jobs:
     - uses: actions/checkout@v4
     - name: Run Tests - Python 3.12
       run: make test-3.12 CI=true
+  # Python 3.13 not supported yet, needs investigation!
+  # test-python-3-13:
+  #   runs-on: ubuntu-22.04
+  #   steps:
+  #   - uses: actions/checkout@v4
+  #   - name: Run Tests - Python 3.13
+  #     run: make test-3.13 CI=true

.gitignore

@@ -20,6 +20,7 @@ hash_checks/results.html
 temp.py
 temp/
 raw/
+scripts/temp/
 
 # Documentation Generated Files
 examples/*.png

Dockerfile

@@ -1,17 +1,11 @@
-ARG PYTHON_VERSION=3.11.7
+ARG PYTHON_VERSION=3.11.11
 FROM python:${PYTHON_VERSION}-bookworm AS base
 
 WORKDIR /starplot
 
+# Install required system libraries (GEOS + GDAL)
 RUN apt-get clean && apt-get update -y && apt-get install -y libgeos-dev libgdal-dev
 
-# Install fonts
-# not required, but make the maps look better (especially greek letters)
-RUN mkdir -p /usr/share/fonts/truetype
-RUN wget https://github.com/google/fonts/raw/main/ofl/gfsdidot/GFSDidot-Regular.ttf -P /tmp/fonts
-RUN install -m644 /tmp/fonts/*.ttf /usr/share/fonts/truetype/
-RUN fc-cache -f
-
 # ---------------------------------------------------------------------
 FROM base as dev
 

Makefile

@@ -22,7 +22,7 @@ DOCKER_RUN_PYTHON_TEST=docker run --rm $(DR_ARGS) -v $(shell pwd):/starplot star
 export PYTHONPATH=./src/
 
 # ------------------------------------------------------------------
-build: PYTHON_VERSION=3.11.7
+build: PYTHON_VERSION=3.11.11
 build: DOCKER_BUILD_ARGS=-t starplot-dev
 build:
 	touch -a .env
@@ -82,26 +82,32 @@ version:
 # ------------------------------------------------------------------
 # Python version testing
 # ------------------------------------------------------------------
-test-3.9: PYTHON_VERSION=3.9.18
+test-3.9: PYTHON_VERSION=3.9.21
 test-3.9:
 	$(DOCKER_BUILD_PYTHON)
 	$(DOCKER_RUN_PYTHON_TEST)
 
-test-3.10: PYTHON_VERSION=3.10.13
+test-3.10: PYTHON_VERSION=3.10.16
 test-3.10:
 	$(DOCKER_BUILD_PYTHON)
 	$(DOCKER_RUN_PYTHON_TEST)
 
-test-3.11: PYTHON_VERSION=3.11.7
+test-3.11: PYTHON_VERSION=3.11.11
 test-3.11:
 	$(DOCKER_BUILD_PYTHON)
 	$(DOCKER_RUN_PYTHON_TEST)
 
-test-3.12: PYTHON_VERSION=3.12.1
+test-3.12: PYTHON_VERSION=3.12.8
 test-3.12:
 	$(DOCKER_BUILD_PYTHON)
 	$(DOCKER_RUN_PYTHON_TEST)
 
+# Python 3.13 not supported yet!
+test-3.13: PYTHON_VERSION=3.13.1
+test-3.13:
+	$(DOCKER_BUILD_PYTHON)
+	$(DOCKER_RUN_PYTHON_TEST)
+
 # ------------------------------------------------------------------
 # Docs
 docs-serve: DR_ARGS=-it -p 8000:8000
@@ -134,6 +140,9 @@ hip8:
 scripts:
 	$(DOCKER_RUN) "python ./scripts/$(SCRIPT).py"
 
+allsky:
+	$(DOCKER_RUN) "python ./scripts/temp/allsky.py"
+
 clean:
 	rm -rf __pycache__
 	rm -rf venv

README.md

@@ -6,7 +6,7 @@
 
 **Starplot** is a Python library for creating star charts and maps of the sky.
 
-- ⭐ **Zenith Plots** - showing the stars from a specific time/location
+- ⭐ **Zenith Plots** - showing the whole sky from a specific time/location
 - 🗺️ **Map Plots** - including many map projections
 - 🔭 **Optic Plots** - simulates what you'll see through an optic (e.g. binoculars, telescope) from a time/location
 - 🪐 **Planets and Deep Sky Objects (DSOs)**
@@ -21,7 +21,7 @@
 *Map around the constellation Orion:*
 ![map-orion](https://starplot.dev/images/examples/map_orion.png)
 
-*Optic plot of The Pleiades through a refractor as seen from a specific time/location:*
+*The Pleiades star cluster, as seen through a refractor telescope from a specific time and location:*
 ![optic-pleiades](https://starplot.dev/images/examples/optic_m45.png)
 
 ## Basic Usage
@@ -42,9 +42,9 @@ p = sp.MapPlot(
     dt=datetime.now(tz).replace(hour=22),
     style=sp.styles.PlotStyle().extend(
         sp.styles.extensions.BLUE_MEDIUM,
-        sp.styles.extensions.ZENITH,
     ),
-    resolution=2000,
+    resolution=3200,
+    autoscale=True,
 )
 p.constellations()
 p.stars(mag=4.6)
@@ -72,12 +72,11 @@ https://discord.gg/WewJJjshFu
 Contributing to Starplot is welcome and very much appreciated! Please see [here](CONTRIBUTING.md) for details.
 
 ## Coming Soon
+- 🌄 Horizon plots
 - 🌑 Planet moons
 - ✴️ Custom markers
-- 🚀 Plotting Optimizations
 - ☄️ Comet model
-- 🌄 Horizon plots
-- ⚖️ Better auto font-size adjustment
+- 💫 Better constellation label placement
 - 😄 🔭 Clear skies
 
 See more details on the [Public Roadmap](https://trello.com/b/sUksygn4/starplot-roadmap)

docs/about.md

@@ -1,6 +1,10 @@
 ![Starplot](images/favicon.svg){ align=right width="128" .off-glb }
 
-**Starplot** is a Python library for creating star charts and maps. It lets you create zenith plots that show the whole sky from a time/place, map plots that show more detail of an area, and optic plots that simulate the field of view from a particular optic (e.g. telescope, binoculars, or a camera).
+**Starplot** is a Python library for creating star charts and maps of the sky. It lets you create zenith plots that show the whole sky from a time/place, map plots that show more detail of an area, and optic plots that simulate the field of view from a particular optic (e.g. telescope, binoculars, or a camera).
+
+👷 **Work In Progress** 🚧 Starplot is still very much a work in progress, and under active development. We try to follow [semantic versioning](https://semver.org/), which means that [_anything_ can change between versions before `1.0.0`](https://semver.org/#spec-item-4).
+
+However, the Starplot API becomes more stable with each new version. We anticipate that version `1.0.0` is still at least a year away. The best way to help us get there faster is to [join as a contributor](https://github.com/steveberardi/starplot/blob/main/CONTRIBUTING.md) 😃 help is wanted and very much appreciated!
 
 Join other starplotters on [Discord :fontawesome-brands-discord:{ .fg-primary }](https://discord.gg/WewJJjshFu)
 

docs/changelog.md

@@ -1,4 +1,17 @@
+## v0.13.x
+
+- Adds a `scale` factor to control sizing of all objects/text
+- Adds an "auto" option for label offsets from markers
+- Adds constellation lines to label collision detection
+- Adds a `gid` to plotted objects to make exported SVGs easier to work with in external applications (e.g. Inkscape)
+- Adds Flamsteed numbers to stars
+- Adds all star names from IAU
+- Adds the standard symbol for planetary nebulae
+- Adds a border size/color property to label styles
+- Bundles fonts: Inter & GFS Didot
+
 ## v0.12.x
+[Documentation](https://archives.starplot.dev/0.12.5/)
 
 - Adds Shapely geometry to all sky object models, including support for `intersects` in `where` clauses
 - Adds kwarg to map plots to allow custom clip paths

docs/coming-soon.md

@@ -1,10 +1,9 @@
 
+- 🌄 Horizon plots
 - 🌑 Planet moons
 - ☄️ Comet model
-- 🌄 Horizon plots
 - ✴️ Custom markers
-- 🚀 Plotting Optimizations
-- ⚖️ Better auto font-size adjustment
+- 💫 Better constellation label placement
 - 😄 🔭 Clear skies
 
 <br/>

docs/examples/map-canis-major.md

@@ -7,6 +7,8 @@ title: Map of Canis Major
 
 ![map-canis-major](/images/examples/map_canis_major.png)
 
+In this example, we set the plot's `clip_path` to the boundary of Canis Major, so only objects in that constellation are plotted:
+
 ```python
 --8<-- "examples/map_canis_major.py"
 ```

docs/examples/map-orion.md

@@ -7,7 +7,7 @@ title: Map of Orion
 
 ![map-orion](/images/examples/map_orion.png)
 
-The following code will create a simple map plot that shows the area around the constellation Orion, including a legend and an ellipse around [Orion's Belt](https://en.wikipedia.org/wiki/Orion%27s_Belt):
+The following code will create a simple map plot that shows the area around the constellation [Orion](https://en.wikipedia.org/wiki/Orion_(constellation)):
 
 ```python
 --8<-- "examples/map_orion.py"