Skip to content

Commit 2f57e2f

Browse files
delucchi-cmudelucchi-cmu
committed
Initial hydration from LINCC PPT.
1 parent 69d0e13 commit 2f57e2f

23 files changed

+1977
-1
lines changed

‎.copier-answers.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Changes here will be overwritten by Copier
2+
_commit: v2.0.7
3+
_src_path: gh:lincc-frameworks/python-project-template
4+
author_email: [email protected]
5+
author_name: LINCC Frameworks
6+
create_example_module: true
7+
custom_install: true
8+
enforce_style:
9+
- pylint
10+
- black
11+
- isort
12+
failure_notification: []
13+
include_benchmarks: false
14+
include_docs: false
15+
mypy_type_checking: none
16+
package_name: lsdb_crossmatch
17+
project_license: BSD
18+
project_name: lsdb-crossmatch
19+
project_organization: astronomy-commons
20+
python_versions:
21+
- '3.10'
22+
- '3.11'
23+
- '3.12'
24+
test_lowest_version: direct

‎.git_archival.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node: $Format:%H$
2+
node-date: $Format:%cI$
3+
describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
4+
ref-names: $Format:%D$

‎.gitattributes‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# For explanation of this file and uses see
2+
# https://git-scm.com/docs/gitattributes
3+
# https://developer.lsst.io/git/git-lfs.html#using-git-lfs-enabled-repositories
4+
# https://lincc-ppt.readthedocs.io/en/latest/practices/git-lfs.html
5+
#
6+
# Used by https://github.com/lsst/afwdata.git
7+
# *.boost filter=lfs diff=lfs merge=lfs -text
8+
# *.dat filter=lfs diff=lfs merge=lfs -text
9+
# *.fits filter=lfs diff=lfs merge=lfs -text
10+
# *.gz filter=lfs diff=lfs merge=lfs -text
11+
#
12+
# apache parquet files
13+
# *.parq filter=lfs diff=lfs merge=lfs -text
14+
#
15+
# sqlite files
16+
# *.sqlite3 filter=lfs diff=lfs merge=lfs -text
17+
#
18+
# gzip files
19+
# *.gz filter=lfs diff=lfs merge=lfs -text
20+
#
21+
# png image files
22+
# *.png filter=lfs diff=lfs merge=lfs -text
23+
24+
.git_archival.txt export-subst

‎.github/ISSUE_TEMPLATE/0-general_issue.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: General issue
3+
about: Quickly create a general issue
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---

‎.github/ISSUE_TEMPLATE/1-bug_report.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Bug report
3+
about: Tell us about a problem to fix
4+
title: 'Short description'
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
**Bug report**
10+
11+
12+
**Before submitting**
13+
Please check the following:
14+
15+
- [ ] I have described the situation in which the bug arose, including what code was executed, information about my environment, and any applicable data others will need to reproduce the problem.
16+
- [ ] I have included available evidence of the unexpected behavior (including error messages, screenshots, and/or plots) as well as a description of what I expected instead.
17+
- [ ] If I have a solution in mind, I have provided an explanation and/or pseudocode and/or task list.

‎.github/ISSUE_TEMPLATE/2-feature_request.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: 'Short description'
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
**Feature request**
11+
12+
13+
**Before submitting**
14+
Please check the following:
15+
16+
- [ ] I have described the purpose of the suggested change, specifying what I need the enhancement to accomplish, i.e. what problem it solves.
17+
- [ ] I have included any relevant links, screenshots, environment information, and data relevant to implementing the requested feature, as well as pseudocode for how I want to access the new functionality.
18+
- [ ] If I have ideas for how the new feature could be implemented, I have provided explanations and/or pseudocode and/or task lists for the steps.

‎.github/dependabot.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "monthly"
7+
- package-ecosystem: "pip"
8+
directory: "/"
9+
schedule:
10+
interval: "monthly"

‎.github/workflows/pre-commit-ci.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
# This workflow runs pre-commit hooks on pushes and pull requests to main
3+
# to enforce coding style. To ensure correct configuration, please refer to:
4+
# https://lincc-ppt.readthedocs.io/en/latest/practices/ci_precommit.html
5+
name: Run pre-commit hooks
6+
7+
on:
8+
push:
9+
branches: [ main ]
10+
pull_request:
11+
branches: [ main ]
12+
13+
jobs:
14+
pre-commit-ci:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v4
18+
with:
19+
fetch-depth: 0
20+
- name: Set up Python
21+
uses: actions/setup-python@v5
22+
with:
23+
python-version: '3.11'
24+
- name: Install dependencies
25+
run: |
26+
sudo apt-get update
27+
python -m pip install --upgrade pip
28+
pip install .[dev]
29+
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
30+
- uses: pre-commit/[email protected]
31+
with:
32+
extra_args: --all-files --verbose
33+
env:
34+
SKIP: "check-lincc-frameworks-template-version,no-commit-to-branch,check-added-large-files,validate-pyproject,sphinx-build,pytest-check"
35+
- uses: pre-commit-ci/[email protected]
36+
if: failure() && github.event_name == 'pull_request' && github.event.pull_request.draft == false

‎.github/workflows/publish-to-pypi.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
2+
# This workflow will upload a Python Package using Twine when a release is created
3+
# For more information see: https://github.com/pypa/gh-action-pypi-publish#trusted-publishing
4+
5+
# This workflow uses actions that are not certified by GitHub.
6+
# They are provided by a third-party and are governed by
7+
# separate terms of service, privacy policy, and support
8+
# documentation.
9+
10+
name: Upload Python Package
11+
12+
on:
13+
release:
14+
types: [published]
15+
16+
permissions:
17+
contents: read
18+
19+
jobs:
20+
deploy:
21+
22+
runs-on: ubuntu-latest
23+
permissions:
24+
id-token: write
25+
steps:
26+
- uses: actions/checkout@v4
27+
- name: Set up Python
28+
uses: actions/setup-python@v5
29+
with:
30+
python-version: '3.11'
31+
- name: Install dependencies
32+
run: |
33+
python -m pip install --upgrade pip
34+
pip install build
35+
- name: Build package
36+
run: python -m build
37+
- name: Publish package
38+
uses: pypa/gh-action-pypi-publish@release/v1

‎.github/workflows/smoke-test.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# This workflow will run daily at 06:45.
2+
# It will install Python dependencies and run tests with a variety of Python versions.
3+
# See documentation for help debugging smoke test issues:
4+
# https://lincc-ppt.readthedocs.io/en/latest/practices/ci_testing.html#version-culprit
5+
6+
name: Unit test smoke test
7+
8+
on:
9+
10+
# Runs this workflow automatically
11+
schedule:
12+
- cron: 45 6 * * *
13+
14+
# Allows you to run this workflow manually from the Actions tab
15+
workflow_dispatch:
16+
17+
jobs:
18+
build:
19+
20+
runs-on: ubuntu-latest
21+
strategy:
22+
matrix:
23+
python-version: ['3.10', '3.11', '3.12']
24+
25+
steps:
26+
- uses: actions/checkout@v4
27+
- name: Set up Python ${{ matrix.python-version }}
28+
uses: actions/setup-python@v5
29+
with:
30+
python-version: ${{ matrix.python-version }}
31+
- name: Install dependencies
32+
run: |
33+
sudo apt-get update
34+
python -m pip install --upgrade pip
35+
pip install -e .[dev]
36+
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
37+
- name: List dependencies
38+
run: |
39+
pip list
40+
- name: Run unit tests with pytest
41+
run: |
42+
python -m pytest

0 commit comments

Comments
 (0)