Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates from the package template #35

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .cruft.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"template": "https://github.com/sunpy/package-template",
"commit": "112d7d4adf0fa168bbb9ddb1886ad4f1e595b8be",
"commit": "dd830771f0bb01d5313912e0082f3434715e474a",
"checkout": null,
"context": {
"cookiecutter": {
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/sub_package_update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ jobs:

- name: Create pull request
if: steps.check.outputs.has_changes == '1'
uses: peter-evans/create-pull-request@v6
uses: peter-evans/create-pull-request@v7
with:
token: ${{ secrets.GITHUB_TOKEN }}
add-paths: ${{ matrix.add-paths }}
Expand Down
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
repos:
# This should be before any formatting hooks like isort
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: "v0.5.2"
rev: "v0.6.9"
hooks:
- id: ruff
args: ["--fix"]
Expand All @@ -11,7 +11,7 @@ repos:
- id: isort
exclude: ".*(.fits|.fts|.fit|.header|.txt|tca.*|extern.*|dkist/extern)$"
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
rev: v5.0.0
hooks:
- id: check-ast
- id: check-case-conflict
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: 2

build:
os: ubuntu-22.04
os: ubuntu-lts-latest
tools:
python: "mambaforge-latest"
jobs:
Expand Down
2 changes: 1 addition & 1 deletion .rtd-environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ name: dkist
channels:
- conda-forge
dependencies:
- python=3.10
- python=3.12
- pip
- graphviz!=2.42.*,!=2.43.*
31 changes: 31 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,34 @@
author = "NSO / AURA"
copyright = f"{datetime.datetime.now().year}, {author}"

<<<<<<<
=======
import datetime

from packaging.version import Version

# -- Project information -----------------------------------------------------

>>>>>>>
# The full version, including alpha/beta/rc tags
<<<<<<<
release = __version__
dkist_version = Version(__version__)
is_release = not(dkist_version.is_prerelease or dkist_version.is_devrelease)
=======
from dkist import __version__

_version = Version(__version__)
version = release = str(_version)
# Avoid "post" appearing in version string in rendered docs
if _version.is_postrelease:
version = release = _version.base_version
# Avoid long githashes in rendered Sphinx docs
elif _version.is_devrelease:
version = release = f"{_version.base_version}.dev{_version.dev}"
is_development = _version.is_devrelease
is_release = not(_version.is_prerelease or _version.is_devrelease)
>>>>>>>

# We want to ignore all warnings in a release version.
if is_release:
Expand Down Expand Up @@ -90,6 +114,13 @@

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
<<<<<<<
=======
master_doc = "index"

# Treat everything in single ` as a Python reference.
default_role = "py:obj"
>>>>>>>

exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "jupyter_execute", "**/*_NOTES.md"]

Expand Down
13 changes: 11 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,16 @@
requires = [
"setuptools>=62.1",
"setuptools_scm[toml]>=6.2",
"wheel",]
"wheel",
]
build-backend = "setuptools.build_meta"

[project]
name = "dkist"
description = "DKIST User Tools"
requires-python = ">=3.10"
readme = { file = "README.rst", content-type = "text/x-rst" }
license = { file = "licenses/LICENSE.rst", content-type = "text/plain" }
license = { file = "licenses/LICENSE.rst" }
authors = [
{ name = "NSO / AURA", email = "[email protected]" },
]
Expand Down Expand Up @@ -71,6 +72,13 @@ docs = [
"ipywidgets",
"accessible-pygments",
"reproject[all]",
<<<<<<<
=======
docs = [
"sphinx",
"sphinx-automodapi",
"packaging",
>>>>>>>
]

[project.urls]
Expand All @@ -85,6 +93,7 @@ zip-safe = false
include-package-data = true

[tool.setuptools.packages.find]
include = ["dkist*"]
exclude = ["dkist._dev*"]

[tool.setuptools_scm]
Expand Down