satelles 0.0.0__tar.gz

satelles-0.0.0/.devcontainer/.env.config

@@ -0,0 +1,5 @@
+#/**************************************************************************************
+
+KEEP_RESOURCE=1
+
+#/**************************************************************************************

satelles-0.0.0/.devcontainer/devcontainer.json

@@ -0,0 +1,66 @@
+{
+  "build": {
+    "dockerfile": "../Dockerfile",
+    "context": "..",
+    "target": "development"
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "charliermarsh.ruff",
+        "ms-python.mypy-type-checker",
+        "ms-python.python",
+        "ms-toolsai.jupyter",
+        "tamasfe.even-better-toml"
+      ]
+    },
+    "recommendations": [
+      "charliermarsh.ruff",
+      "ms-python.mypy-type-checker",
+      "ms-python.python",
+      "ms-toolsai.jupyter",
+      "tamasfe.even-better-toml"
+    ],
+    "settings": {
+      "[python]": {
+        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.formatOnSave": true,
+        "editor.semanticHighlighting.enabled": true
+      },
+      "editor.codeActionsOnSave": {
+        "source.organizeImports": "explicit"
+      },
+      "editor.cursorBlinking": "smooth",
+      "editor.cursorSmoothCaretAnimation": "on",
+      "editor.cursorStyle": "line",
+      "editor.formatOnSave": true,
+      "editor.rulers": [
+        88
+      ],
+      "explorer.compactFolders": true,
+      "explorer.confirmDelete": true,
+      "ruff.codeAction.disableRuleComment": {
+        "enable": true
+      },
+      "ruff.enable": true,
+      "ruff.fixAll": true,
+      "ruff.importStrategy": "fromEnvironment",
+      "ruff.lint.enable": true,
+      "ruff.organizeImports": true,
+    },
+    "terminal.integrated.defaultProfile.linux": "zsh",
+    "terminal.integrated.profiles.linux": {
+      "zsh": {
+        "path": "zsh"
+      }
+    }
+  },
+  "forwardPorts": [],
+  "postStartCommand": "/bin/zsh",
+  "runArgs": [
+    "--network=host",
+    "--privileged",
+    "--env-file",
+    "${localWorkspaceFolder}/.devcontainer/.env.config"
+  ]
+}

satelles-0.0.0/.github/semantic.yml

@@ -0,0 +1,5 @@
+# Always validate the PR title AND all the commits
+titleAndCommits: true
+# Allows use of Merge commits (eg on github: "Merge branch 'master' into feature/ride-unicorns")
+# this is only relevant when using commitsOnly: true (or titleAndCommits: true)
+allowMergeCommits: true

satelles-0.0.0/.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: satelles/ci
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+      - release
+      - latest
+
+    paths-ignore:
+      - "__pycache__"
+      - ".pytest_cache"
+      - ".ruff_cache"
+      - "docs/**"
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  ci:
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout 🛎
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Synchronise uv environment
+        run: |
+          uv sync --all-extras --dev
+
+      - name: Lint w/Ruff
+        run: |
+          uv run ruff check
+
+      - name: Format w/Ruff
+        run: |
+          uv run ruff format
+
+      - name: Static Analysis w/mypy
+        run: |
+          uv run mypy ./src/satelles --config mypy.ini
+
+      - name: Build w/Hatch Build Backend 🔧
+        run: |
+          uv build

satelles-0.0.0/.github/workflows/publish.yml

@@ -0,0 +1,44 @@
+name: satelles/publish
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    environment: pypi
+    permissions:
+      contents: read
+      packages: write
+      id-token: write
+
+    steps:
+      - name: Checkout 🛎
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Synchronise uv environment
+        run: |
+          uv sync --all-extras --dev
+
+      - name: Test w/pytest
+        run: |
+          uv run --link-mode=copy pytest test
+
+      - name: Build w/Hatch Build Backend 🔧
+        run: |
+          uv build
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

satelles-0.0.0/.github/workflows/test.yml

@@ -0,0 +1,44 @@
+name: satelles/test
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+      - release
+      - latest
+
+    paths-ignore:
+      - "__pycache__"
+      - ".pytest_cache"
+      - ".ruff_cache"
+      - "docs/**"
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout 🛎
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Synchronise uv environment
+        run: |
+          uv sync --all-extras --dev
+
+      - name: Test w/pytest
+        run: |
+          uv run --link-mode=copy pytest test

satelles-0.0.0/.gitignore

@@ -0,0 +1,171 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc

satelles-0.0.0/.python-version

@@ -0,0 +1 @@
+3.13

satelles-0.0.0/.vscode/recommendations.json

@@ -0,0 +1,9 @@
+{
+  "recommendations": [
+    "charliermarsh.ruff",
+    "ms-python.mypy-type-checker",
+    "ms-python.python",
+    "ms-toolsai.jupyter",
+    "tamasfe.even-better-toml"
+  ]
+}

satelles-0.0.0/.vscode/settings.json

@@ -0,0 +1,27 @@
+{
+  "[python]": {
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.formatOnSave": true,
+    "editor.semanticHighlighting.enabled": true,
+  },
+  "editor.codeActionsOnSave": {
+    "source.organizeImports": "explicit"
+  },
+  "editor.cursorBlinking": "smooth",
+  "editor.cursorSmoothCaretAnimation": "on",
+  "editor.cursorStyle": "line",
+  "editor.formatOnSave": true,
+  "editor.rulers": [
+    88
+  ],
+  "explorer.compactFolders": true,
+  "explorer.confirmDelete": true,
+  "ruff.codeAction.disableRuleComment": {
+    "enable": true
+  },
+  "ruff.enable": true,
+  "ruff.fixAll": true,
+  "ruff.importStrategy": "fromEnvironment",
+  "ruff.lint.enable": true,
+  "ruff.organizeImports": true
+}

satelles-0.0.0/Dockerfile

@@ -0,0 +1,74 @@
+# //////////////////////////////////////////////////////////////////////////////////////////////////////////////////// #
+
+FROM python:3.13-slim-bookworm AS base
+
+# The installer requires curl (and certificates) to download the release archive
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    curl \
+    ca-certificates \
+    wget \
+    zsh \
+    && rm -rf /var/lib/apt/lists/*
+
+# Download the latest installer
+ADD https://astral.sh/uv/install.sh /uv-installer.sh
+
+# Run the installer then remove it
+RUN sh /uv-installer.sh && rm /uv-installer.sh
+
+# Ensure the installed binary is on the `PATH`
+ENV PATH="/root/.local/bin/:$PATH"
+
+# //////////////////////////////////////////////////////////////////////////////////////////////////////////////////// #
+
+FROM base AS development
+
+# A cache mount can be used to improve performance across builds:
+ENV UV_LINK_MODE=copy
+
+# Install necessary packages: gcc, make, libc-dev, bash, curl, and openssh-client
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    bash \
+    curl \
+    build-essential \
+    clang \             
+    git \
+    libc-dev \
+    make \
+    openssh-client \
+    python3-setuptools \
+    unzip \
+    usbutils \
+    wget \
+    zsh \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install Oh My Zsh (if needed)
+RUN sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
+
+# Install oh-my-zsh:
+# Uses "Spaceship" theme with some customization. Uses some bundled plugins and installs some more from github
+RUN sh -c "$(wget -O- https://github.com/deluan/zsh-in-docker/releases/download/v1.1.5/zsh-in-docker.sh)" -- \
+    -t https://github.com/denysdovhan/spaceship-prompt \
+    -a 'SPACESHIP_PROMPT_ADD_NEWLINE="false"' \
+    -a 'SPACESHIP_PROMPT_SEPARATE_LINE="false"' \
+    -p git \
+    -p ssh-agent \
+    -p https://github.com/zsh-users/zsh-autosuggestions \
+    -p https://github.com/zsh-users/zsh-completions
+
+# Enable shell completions for `uv`
+RUN echo eval "$(uv generate-shell-completion zsh)" >> ~/.zshrc
+
+# Enable shell completions for `uvx`
+RUN echo eval "$(uvx generate-shell-completion zsh)" >> ~/.zshrc
+
+COPY . /usr/src/app
+
+# Set the working directory to /app
+WORKDIR /usr/src/app
+
+# Sync the project into a new environment, using the frozen lockfile
+# RUN --mount=type=cache,target=/root/.cache/uv uv sync
+
+# //////////////////////////////////////////////////////////////////////////////////////////////////////////////////// #

satelles-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Michael J. Roberts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

satelles-0.0.0/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: satelles
+Version: 0.0.0
+Summary: Add your description here
+Author-email: michealroberts <michael@observerly.com>
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: pydantic>=2.10.6
+Description-Content-Type: text/markdown
+
+# satelles
+A hypermodern python package starter template with astral uv ruff and mypy

satelles-0.0.0/README.md

@@ -0,0 +1,2 @@
+# satelles
+A hypermodern python package starter template with astral uv ruff and mypy

satelles-0.0.0/mypy.ini

@@ -0,0 +1,4 @@
+[mypy]
+mypy_path = src
+namespace_packages = True
+explicit_package_bases = True

satelles-0.0.0/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "satelles"
+version = "0.0.0"
+description = "Add your description here"
+readme = "README.md"
+authors = [{ name = "michealroberts", email = "michael@observerly.com" }]
+requires-python = ">=3.13"
+dependencies = ["pydantic>=2.10.6"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "astropy>=7.0.1",
+    "mypy>=1.15.0",
+    "pre-commit>=4.1.0",
+    "pytest>=8.3.4",
+    "pytest-asyncio>=0.25.3",
+    "pytest-cov>=6.0.0",
+    "ruff>=0.9.7",
+]
+
+[tool.pytest.ini_options]
+pythonpath = [".", "src"]
+asyncio_default_fixture_loop_scope = "session"

satelles-0.0.0/ruff.toml

@@ -0,0 +1,77 @@
+# Exclude a variety of commonly ignored directories.
+exclude = [
+  ".bzr",
+  ".direnv",
+  ".eggs",
+  ".git",
+  ".git-rewrite",
+  ".hg",
+  ".ipynb_checkpoints",
+  ".mypy_cache",
+  ".nox",
+  ".pants.d",
+  ".pyenv",
+  ".pytest_cache",
+  ".pytype",
+  ".ruff_cache",
+  ".svn",
+  ".tox",
+  ".venv",
+  ".vscode",
+  "__pypackages__",
+  "_build",
+  "buck-out",
+  "build",
+  "dist",
+  "node_modules",
+  "site-packages",
+  "venv",
+]
+
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+# Assume Python 3.13
+target-version = "py313"
+
+[lint]
+# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
+# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
+# McCabe complexity (`C901`) by default.
+select = ["E4", "E7", "E9", "F"]
+ignore = []
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = false
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"

satelles-0.0.0/src/satelles/__init__.py

@@ -0,0 +1,26 @@
+# **************************************************************************************
+
+# @package        satelles
+# @license        MIT License Copyright (c) 2025 Michael J. Roberts
+
+# **************************************************************************************
+
+from .satellite import Satellite
+from .tle import TLE
+
+# **************************************************************************************
+
+__version__ = "0.0.0"
+
+# **************************************************************************************
+
+__license__ = "MIT"
+
+# **************************************************************************************
+
+__all__: list[str] = [
+    "Satellite",
+    "TLE",
+]
+
+# **************************************************************************************