Skip to content

Commit 194d8f1

Browse files
jeffjenningsjeffjennings
authored
Initial commit
0 parents  commit 194d8f1

File tree

10 files changed

+282
-0
lines changed

10 files changed

+282
-0
lines changed

‎.github/workflows/build.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: 'Call actions to pre-process config files and execute/convert notebook'
2+
3+
env:
4+
PYTHON-VERSION: "3.12"
5+
6+
on:
7+
push:
8+
branches:
9+
- main
10+
schedule:
11+
# daily at 07:20 UTC
12+
- cron: "20 07 * * *"
13+
# allow manual triggering of workflow
14+
workflow_dispatch:
15+
16+
jobs:
17+
preprocess-execute-convert:
18+
runs-on: ubuntu-latest
19+
if: ${{ github.repository != 'astropy-learn/tutorial--template' }}
20+
permissions:
21+
contents: write
22+
steps:
23+
- name: Call custom action to pre-process config files
24+
id: pre-process
25+
uses: astropy-learn/action--pre-process@main
26+
with:
27+
python-version: ${{ env.PYTHON-VERSION }}
28+
29+
- name: Call custom action to execute and convert notebook
30+
uses: astropy-learn/action--execute-convert@main
31+
with:
32+
python-version: ${{ env.PYTHON-VERSION }}
33+
tutorial-slug: ${{ steps.pre-process.outputs.tutorial-slug }}

‎.gitignore

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
# Mac
2+
.DS_Store
3+
4+
# act
5+
/bin/act
6+
7+
# Byte-compiled / optimized / DLL files
8+
__pycache__/
9+
*.py[cod]
10+
*$py.class
11+
12+
# C extensions
13+
*.so
14+
15+
# Jupyterbook output
16+
_build/
17+
18+
# Distribution / packaging
19+
.Python
20+
build/
21+
develop-eggs/
22+
dist/
23+
downloads/
24+
eggs/
25+
.eggs/
26+
lib/
27+
lib64/
28+
parts/
29+
sdist/
30+
var/
31+
wheels/
32+
share/python-wheels/
33+
*.egg-info/
34+
.installed.cfg
35+
*.egg
36+
MANIFEST
37+
38+
# PyInstaller
39+
# Usually these files are written by a python script from a template
40+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
41+
*.manifest
42+
*.spec
43+
44+
# Installer logs
45+
pip-log.txt
46+
pip-delete-this-directory.txt
47+
48+
# Unit test / coverage reports
49+
htmlcov/
50+
.tox/
51+
.nox/
52+
.coverage
53+
.coverage.*
54+
.cache
55+
nosetests.xml
56+
coverage.xml
57+
*.cover
58+
*.py,cover
59+
.hypothesis/
60+
.pytest_cache/
61+
cover/
62+
63+
# Translations
64+
*.mo
65+
*.pot
66+
67+
# Django stuff:
68+
*.log
69+
local_settings.py
70+
db.sqlite3
71+
db.sqlite3-journal
72+
73+
# Flask stuff:
74+
instance/
75+
.webassets-cache
76+
77+
# Scrapy stuff:
78+
.scrapy
79+
80+
# Sphinx documentation
81+
docs/_build/
82+
83+
# PyBuilder
84+
.pybuilder/
85+
target/
86+
87+
# Jupyter Notebook
88+
.ipynb_checkpoints
89+
90+
# IPython
91+
profile_default/
92+
ipython_config.py
93+
94+
# pyenv
95+
# For a library or package, you might want to ignore these files since the code is
96+
# intended to run in multiple environments; otherwise, check them in:
97+
# .python-version
98+
99+
# pipenv
100+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
101+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
102+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
103+
# install all needed dependencies.
104+
#Pipfile.lock
105+
106+
# UV
107+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
108+
# This is especially recommended for binary packages to ensure reproducibility, and is more
109+
# commonly ignored for libraries.
110+
#uv.lock
111+
112+
# poetry
113+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
114+
# This is especially recommended for binary packages to ensure reproducibility, and is more
115+
# commonly ignored for libraries.
116+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
117+
#poetry.lock
118+
119+
# pdm
120+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
121+
#pdm.lock
122+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
123+
# in version control.
124+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
125+
.pdm.toml
126+
.pdm-python
127+
.pdm-build/
128+
129+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
130+
__pypackages__/
131+
132+
# Celery stuff
133+
celerybeat-schedule
134+
celerybeat.pid
135+
136+
# SageMath parsed files
137+
*.sage.py
138+
139+
# Environments
140+
.env
141+
.venv
142+
env/
143+
venv/
144+
ENV/
145+
env.bak/
146+
venv.bak/
147+
148+
# Spyder project settings
149+
.spyderproject
150+
.spyproject
151+
152+
# Rope project settings
153+
.ropeproject
154+
155+
# mkdocs documentation
156+
/site
157+
158+
# mypy
159+
.mypy_cache/
160+
.dmypy.json
161+
dmypy.json
162+
163+
# Pyre type checker
164+
.pyre/
165+
166+
# pytype static type analyzer
167+
.pytype/
168+
169+
# Cython debug symbols
170+
cython_debug/
171+
172+
# PyCharm
173+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
174+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
175+
# and can be added to the global gitignore or merged into this file. For a more nuclear
176+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
177+
#.idea/
178+
179+
# PyPI configuration file
180+
.pypirc

‎.pre-commit-config.yaml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# See https://pre-commit.com for more information
2+
# See https://pre-commit.com/hooks.html for more hooks
3+
4+
ci:
5+
autoupdate_commit_msg: "chore: update pre-commit hooks"
6+
autofix_commit_msg: "style: pre-commit fixes"
7+
autofix_prs: true
8+
9+
repos:
10+
- repo: https://github.com/astral-sh/ruff-pre-commit
11+
rev: "v0.11.13"
12+
hooks:
13+
- id: ruff
14+
types_or: [python, pyi, jupyter]
15+
args: [--fix, --show-fixes]
16+
- id: ruff-format
17+
types_or: [python, pyi, jupyter]
18+
19+
- repo: https://github.com/pre-commit/pre-commit-hooks
20+
rev: v5.0.0
21+
hooks:
22+
- id: trailing-whitespace
23+
exclude: '.*\.fits$'
24+
- id: end-of-file-fixer
25+
exclude_types: [csv]
26+
exclude: '.*\.fits$'
27+
- id: check-yaml
28+
# prevent addition of (presumably data) files >= 1 MB
29+
# (for such files, see https://learn.astropy.org/contributing/how-to-contribute)
30+
- id: check-added-large-files
31+
args: ["--maxkb=1000"]
32+
33+
- repo: https://github.com/kynan/nbstripout
34+
rev: 0.8.1
35+
hooks:
36+
- id: nbstripout
37+
args: ["--extra-keys=metadata.kernelspec metadata.language_info.version metadata.toc"]

‎AUTHORS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AUTHOR1 (@GITHUB-USERNAME, ORCID-ID), AUTHOR2 (@GITHUB-USERNAME, ORCID-ID)

‎LICENSE

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
BSD 3-Clause License
2+
3+
Copyright (c) 2025, astropy-learn
4+
5+
Redistribution and use in source and binary forms, with or without
6+
modification, are permitted provided that the following conditions are met:
7+
8+
1. Redistributions of source code must retain the above copyright notice, this
9+
list of conditions and the following disclaimer.
10+
11+
2. Redistributions in binary form must reproduce the above copyright notice,
12+
this list of conditions and the following disclaimer in the documentation
13+
and/or other materials provided with the distribution.
14+
15+
3. Neither the name of the copyright holder nor the names of its
16+
contributors may be used to endorse or promote products derived from
17+
this software without specific prior written permission.
18+
19+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎README.md

Whitespace-only changes.

‎_toc.yml

Whitespace-only changes.

‎index.md

Whitespace-only changes.

‎metadata.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
title: "Example Title"
2+
slug: "Example-Title"
3+
source: "tutorial--example-title"

‎requirements.txt

Whitespace-only changes.

0 commit comments

Comments
 (0)