zenodo-release-drift 0.0.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- zenodo_release_drift-0.0.1/.gitignore +221 -0
- zenodo_release_drift-0.0.1/.pre-commit-config.yaml +72 -0
- zenodo_release_drift-0.0.1/.python-version +1 -0
- zenodo_release_drift-0.0.1/AGENTS.md +43 -0
- zenodo_release_drift-0.0.1/CITATION.cff +34 -0
- zenodo_release_drift-0.0.1/CODE_OF_CONDUCT.md +132 -0
- zenodo_release_drift-0.0.1/CONTRIBUTING.md +129 -0
- zenodo_release_drift-0.0.1/LICENSE +28 -0
- zenodo_release_drift-0.0.1/MANIFEST.in +13 -0
- zenodo_release_drift-0.0.1/PKG-INFO +236 -0
- zenodo_release_drift-0.0.1/README.md +216 -0
- zenodo_release_drift-0.0.1/pyproject.toml +129 -0
- zenodo_release_drift-0.0.1/setup.cfg +4 -0
- zenodo_release_drift-0.0.1/src/notebooks/example_notebook.ipynb +76 -0
- zenodo_release_drift-0.0.1/src/notebooks/example_notebook.py +22 -0
- zenodo_release_drift-0.0.1/src/zenodo_release_drift/__init__.py +5 -0
- zenodo_release_drift-0.0.1/src/zenodo_release_drift/_version.py +24 -0
- zenodo_release_drift-0.0.1/src/zenodo_release_drift/cli.py +320 -0
- zenodo_release_drift-0.0.1/src/zenodo_release_drift/main.py +606 -0
- zenodo_release_drift-0.0.1/src/zenodo_release_drift.egg-info/PKG-INFO +236 -0
- zenodo_release_drift-0.0.1/src/zenodo_release_drift.egg-info/SOURCES.txt +24 -0
- zenodo_release_drift-0.0.1/src/zenodo_release_drift.egg-info/dependency_links.txt +1 -0
- zenodo_release_drift-0.0.1/src/zenodo_release_drift.egg-info/entry_points.txt +2 -0
- zenodo_release_drift-0.0.1/src/zenodo_release_drift.egg-info/requires.txt +5 -0
- zenodo_release_drift-0.0.1/src/zenodo_release_drift.egg-info/top_level.txt +1 -0
- zenodo_release_drift-0.0.1/uv.lock +2353 -0
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[codz]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py.cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
# Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# UV
|
|
98
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
99
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
100
|
+
# commonly ignored for libraries.
|
|
101
|
+
# uv.lock
|
|
102
|
+
|
|
103
|
+
# poetry
|
|
104
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
105
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
106
|
+
# commonly ignored for libraries.
|
|
107
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
108
|
+
# poetry.lock
|
|
109
|
+
# poetry.toml
|
|
110
|
+
|
|
111
|
+
# pdm
|
|
112
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
113
|
+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
|
114
|
+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
|
115
|
+
# pdm.lock
|
|
116
|
+
# pdm.toml
|
|
117
|
+
.pdm-python
|
|
118
|
+
.pdm-build/
|
|
119
|
+
|
|
120
|
+
# pixi
|
|
121
|
+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
|
122
|
+
# pixi.lock
|
|
123
|
+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
|
124
|
+
# in the .venv directory. It is recommended not to include this directory in version control.
|
|
125
|
+
.pixi
|
|
126
|
+
|
|
127
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
128
|
+
__pypackages__/
|
|
129
|
+
|
|
130
|
+
# Celery stuff
|
|
131
|
+
celerybeat-schedule
|
|
132
|
+
celerybeat.pid
|
|
133
|
+
|
|
134
|
+
# Redis
|
|
135
|
+
*.rdb
|
|
136
|
+
*.aof
|
|
137
|
+
*.pid
|
|
138
|
+
|
|
139
|
+
# RabbitMQ
|
|
140
|
+
mnesia/
|
|
141
|
+
rabbitmq/
|
|
142
|
+
rabbitmq-data/
|
|
143
|
+
|
|
144
|
+
# ActiveMQ
|
|
145
|
+
activemq-data/
|
|
146
|
+
|
|
147
|
+
# SageMath parsed files
|
|
148
|
+
*.sage.py
|
|
149
|
+
|
|
150
|
+
# Environments
|
|
151
|
+
.env
|
|
152
|
+
.envrc
|
|
153
|
+
.venv
|
|
154
|
+
env/
|
|
155
|
+
venv/
|
|
156
|
+
ENV/
|
|
157
|
+
env.bak/
|
|
158
|
+
venv.bak/
|
|
159
|
+
|
|
160
|
+
# Spyder project settings
|
|
161
|
+
.spyderproject
|
|
162
|
+
.spyproject
|
|
163
|
+
|
|
164
|
+
# Rope project settings
|
|
165
|
+
.ropeproject
|
|
166
|
+
|
|
167
|
+
# mkdocs documentation
|
|
168
|
+
/site
|
|
169
|
+
|
|
170
|
+
# mypy
|
|
171
|
+
.mypy_cache/
|
|
172
|
+
.dmypy.json
|
|
173
|
+
dmypy.json
|
|
174
|
+
|
|
175
|
+
# Pyre type checker
|
|
176
|
+
.pyre/
|
|
177
|
+
|
|
178
|
+
# pytype static type analyzer
|
|
179
|
+
.pytype/
|
|
180
|
+
|
|
181
|
+
# Cython debug symbols
|
|
182
|
+
cython_debug/
|
|
183
|
+
|
|
184
|
+
# PyCharm
|
|
185
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
186
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
187
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
188
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
189
|
+
# .idea/
|
|
190
|
+
|
|
191
|
+
# Abstra
|
|
192
|
+
# Abstra is an AI-powered process automation framework.
|
|
193
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
194
|
+
# Learn more at https://abstra.io/docs
|
|
195
|
+
.abstra/
|
|
196
|
+
|
|
197
|
+
# Visual Studio Code
|
|
198
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
199
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
200
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
201
|
+
# you could uncomment the following to ignore the entire vscode folder
|
|
202
|
+
# .vscode/
|
|
203
|
+
# Temporary file for partial code execution
|
|
204
|
+
tempCodeRunnerFile.py
|
|
205
|
+
|
|
206
|
+
# Ruff stuff:
|
|
207
|
+
.ruff_cache/
|
|
208
|
+
|
|
209
|
+
# setuptools-scm generated version file (do not track)
|
|
210
|
+
src/zenodo_release_drift/_version.py
|
|
211
|
+
|
|
212
|
+
# PyPI configuration file
|
|
213
|
+
.pypirc
|
|
214
|
+
|
|
215
|
+
# Marimo
|
|
216
|
+
marimo/_static/
|
|
217
|
+
marimo/_lsp/
|
|
218
|
+
__marimo__/
|
|
219
|
+
|
|
220
|
+
# Streamlit
|
|
221
|
+
.streamlit/secrets.toml
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# See https://pre-commit.com for more information
|
|
2
|
+
# See https://pre-commit.com/hooks.html for more hooks
|
|
3
|
+
repos:
|
|
4
|
+
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
5
|
+
rev: v6.0.0
|
|
6
|
+
hooks:
|
|
7
|
+
- id: trailing-whitespace
|
|
8
|
+
- id: end-of-file-fixer
|
|
9
|
+
- id: check-yaml
|
|
10
|
+
- id: detect-private-key
|
|
11
|
+
- repo: https://github.com/tox-dev/pyproject-fmt
|
|
12
|
+
rev: "v2.23.0"
|
|
13
|
+
hooks:
|
|
14
|
+
- id: pyproject-fmt
|
|
15
|
+
- repo: https://github.com/citation-file-format/cffconvert
|
|
16
|
+
rev: b6045d78aac9e02b039703b030588d54d53262ac
|
|
17
|
+
hooks:
|
|
18
|
+
- id: validate-cff
|
|
19
|
+
- repo: https://github.com/codespell-project/codespell
|
|
20
|
+
rev: v2.4.2
|
|
21
|
+
hooks:
|
|
22
|
+
- id: codespell
|
|
23
|
+
exclude: |
|
|
24
|
+
(?x)^(
|
|
25
|
+
.*\.lock |
|
|
26
|
+
.*\.csv |
|
|
27
|
+
.*\.cff |
|
|
28
|
+
.*\.ipynb
|
|
29
|
+
)$
|
|
30
|
+
- repo: https://github.com/executablebooks/mdformat
|
|
31
|
+
rev: 1.0.0
|
|
32
|
+
hooks:
|
|
33
|
+
- id: mdformat
|
|
34
|
+
additional_dependencies:
|
|
35
|
+
- mdformat-gfm
|
|
36
|
+
- repo: https://github.com/CU-DBMI/onesentence
|
|
37
|
+
rev: 3161573091c3868c01c9d3ae5f549e5c38aa5eb3
|
|
38
|
+
hooks:
|
|
39
|
+
- id: check
|
|
40
|
+
types: [markdown]
|
|
41
|
+
exclude: |
|
|
42
|
+
(?x)^(
|
|
43
|
+
CODE_OF_CONDUCT\.md |
|
|
44
|
+
zenodo-release-drift-roadmap\.md |
|
|
45
|
+
\.agents/.*
|
|
46
|
+
)$
|
|
47
|
+
- repo: https://github.com/adrienverge/yamllint
|
|
48
|
+
rev: v1.38.0
|
|
49
|
+
hooks:
|
|
50
|
+
- id: yamllint
|
|
51
|
+
exclude: pre-commit-config.yaml
|
|
52
|
+
- repo: https://github.com/astral-sh/ruff-pre-commit
|
|
53
|
+
rev: "v0.15.15"
|
|
54
|
+
hooks:
|
|
55
|
+
- id: ruff-format
|
|
56
|
+
- id: ruff-check
|
|
57
|
+
- repo: https://github.com/rhysd/actionlint
|
|
58
|
+
rev: v1.7.12
|
|
59
|
+
hooks:
|
|
60
|
+
- id: actionlint
|
|
61
|
+
- repo: https://github.com/jendrikseipp/vulture
|
|
62
|
+
rev: 'v2.16'
|
|
63
|
+
hooks:
|
|
64
|
+
- id: vulture
|
|
65
|
+
- repo: local
|
|
66
|
+
hooks:
|
|
67
|
+
- id: ty
|
|
68
|
+
name: ty
|
|
69
|
+
entry: uv run --frozen --with ty ty check --ignore unresolved-import
|
|
70
|
+
language: system
|
|
71
|
+
files: ^(src|tests)/.*\.py$
|
|
72
|
+
exclude: ^src/zenodo_release_drift/_version\.py$
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
3.11
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Agent Guide
|
|
2
|
+
|
|
3
|
+
This repository includes local agent guidance in `.agents/skills/`.
|
|
4
|
+
Each skill provides context for a specific aspect of development work.
|
|
5
|
+
|
|
6
|
+
## Where agent guidance lives
|
|
7
|
+
|
|
8
|
+
- Root guide: `AGENTS.md`
|
|
9
|
+
- Skills directory: `.agents/skills/`
|
|
10
|
+
- Skill directories:
|
|
11
|
+
- `.agents/skills/test-driven-development/SKILL.md`
|
|
12
|
+
- `.agents/skills/incremental-implementation/SKILL.md`
|
|
13
|
+
- `.agents/skills/code-review-and-quality/SKILL.md`
|
|
14
|
+
- `.agents/skills/ci-cd-and-automation/SKILL.md`
|
|
15
|
+
- `.agents/skills/debugging-and-error-recovery/SKILL.md`
|
|
16
|
+
- `.agents/skills/learning-opportunities/SKILL.md`
|
|
17
|
+
|
|
18
|
+
## How to use these skills
|
|
19
|
+
|
|
20
|
+
- Load relevant skill(s) before making edits.
|
|
21
|
+
- Prefer small changes with frequent validation.
|
|
22
|
+
- Keep work aligned with this project's `pyproject.toml`, CI workflows, and pre-commit hooks.
|
|
23
|
+
|
|
24
|
+
## Default execution order
|
|
25
|
+
|
|
26
|
+
1. Apply `test-driven-development` when behavior changes.
|
|
27
|
+
1. Apply `incremental-implementation` for multi-file or higher-risk changes.
|
|
28
|
+
1. Apply `code-review-and-quality` as the final quality gate before completion.
|
|
29
|
+
1. Apply `ci-cd-and-automation` when changing checks, tasks, or pipelines.
|
|
30
|
+
1. Apply `debugging-and-error-recovery` when tests, CI, or runtime behavior fails unexpectedly.
|
|
31
|
+
1. Optionally apply `learning-opportunities` for 10-15 minute learning exercises after design-heavy work.
|
|
32
|
+
|
|
33
|
+
## Local commands
|
|
34
|
+
|
|
35
|
+
- Run tests: `uv run --frozen pytest`
|
|
36
|
+
- Run lint/format hooks: `pre-commit run --all-files`
|
|
37
|
+
- Run type checks via pre-commit hook: `pre-commit run ty --all-files`
|
|
38
|
+
- Run full local pipeline: `uv run --frozen poe pipeline`
|
|
39
|
+
|
|
40
|
+
## Scope expectations
|
|
41
|
+
|
|
42
|
+
- These instructions are project-local.
|
|
43
|
+
- If team standards evolve, update these files in-place.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# This CITATION.cff file was generated with cffinit.
|
|
2
|
+
# Visit https://bit.ly/cffinit to generate yours today!
|
|
3
|
+
---
|
|
4
|
+
cff-version: 1.2.0
|
|
5
|
+
title: zenodo-release-drift
|
|
6
|
+
message: >-
|
|
7
|
+
If you use this software, please cite it using the
|
|
8
|
+
metadata from the CITATION.cff file.
|
|
9
|
+
type: software
|
|
10
|
+
authors:
|
|
11
|
+
- given-names: Dave
|
|
12
|
+
family-names: Bunten
|
|
13
|
+
orcid: "https://orcid.org/0000-0001-6041-3665"
|
|
14
|
+
repository-code: "https://github.com/d33bs/zenodo-release-drift"
|
|
15
|
+
abstract: >-
|
|
16
|
+
Detect drift between GitHub releases and Zenodo archives
|
|
17
|
+
keywords:
|
|
18
|
+
- python
|
|
19
|
+
license: BSD-3-Clause
|
|
20
|
+
references:
|
|
21
|
+
- type: software
|
|
22
|
+
title: "agent-skills"
|
|
23
|
+
authors:
|
|
24
|
+
- given-names: Addy
|
|
25
|
+
family-names: Osmani
|
|
26
|
+
repository-code: "https://github.com/addyosmani/agent-skills"
|
|
27
|
+
license: MIT
|
|
28
|
+
- type: software
|
|
29
|
+
title: "learning-opportunities"
|
|
30
|
+
authors:
|
|
31
|
+
- given-names: Cat
|
|
32
|
+
family-names: Hicks
|
|
33
|
+
repository-code: "https://github.com/DrCatHicks/learning-opportunities"
|
|
34
|
+
license: CC-BY-4.0
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socioeconomic status,
|
|
9
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
10
|
+
identity and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
14
|
+
|
|
15
|
+
## Our Standards
|
|
16
|
+
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
19
|
+
|
|
20
|
+
- Demonstrating empathy and kindness toward other people
|
|
21
|
+
- Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
- Giving and gracefully accepting constructive feedback
|
|
23
|
+
- Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
- Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
+
community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
29
|
+
|
|
30
|
+
- The use of sexualized language or imagery, and sexual attention or advances of
|
|
31
|
+
any kind
|
|
32
|
+
- Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
+
- Public or private harassment
|
|
34
|
+
- Publishing others' private information, such as a physical or email address,
|
|
35
|
+
without their explicit permission
|
|
36
|
+
- Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
38
|
+
|
|
39
|
+
## Enforcement Responsibilities
|
|
40
|
+
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
45
|
+
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official email address,
|
|
56
|
+
posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
58
|
+
|
|
59
|
+
## Enforcement
|
|
60
|
+
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to community leaders responsible for enforcement.
|
|
63
|
+
Please reach out to the maintainers of this repository by using their GitHub profile email address contact information to privately notify us of any incidents of this nature.
|
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
+
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
68
|
+
|
|
69
|
+
## Enforcement Guidelines
|
|
70
|
+
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
+
|
|
74
|
+
### 1. Correction
|
|
75
|
+
|
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
unprofessional or unwelcome in the community.
|
|
78
|
+
|
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
|
82
|
+
|
|
83
|
+
### 2. Warning
|
|
84
|
+
|
|
85
|
+
**Community Impact**: A violation through a single incident or series of
|
|
86
|
+
actions.
|
|
87
|
+
|
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
|
93
|
+
ban.
|
|
94
|
+
|
|
95
|
+
### 3. Temporary Ban
|
|
96
|
+
|
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
sustained inappropriate behavior.
|
|
99
|
+
|
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
communication with the community for a specified period of time. No public or
|
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
+
Violating these terms may lead to a permanent ban.
|
|
105
|
+
|
|
106
|
+
### 4. Permanent Ban
|
|
107
|
+
|
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
+
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
113
|
+
community.
|
|
114
|
+
|
|
115
|
+
## Attribution
|
|
116
|
+
|
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
+
version 2.1, available at
|
|
119
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
120
|
+
|
|
121
|
+
Community Impact Guidelines were inspired by
|
|
122
|
+
[Mozilla's code of conduct enforcement ladder][mozilla coc].
|
|
123
|
+
|
|
124
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
125
|
+
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
|
|
126
|
+
[https://www.contributor-covenant.org/translations][translations].
|
|
127
|
+
|
|
128
|
+
[faq]: https://www.contributor-covenant.org/faq
|
|
129
|
+
[homepage]: https://www.contributor-covenant.org
|
|
130
|
+
[mozilla coc]: https://github.com/mozilla/diversity
|
|
131
|
+
[translations]: https://www.contributor-covenant.org/translations
|
|
132
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
First of all, thank you so much for contributing! 🎉 💯
|
|
4
|
+
|
|
5
|
+
This document contains guidelines on how to most effectively contribute within this repository.
|
|
6
|
+
|
|
7
|
+
If you are stuck, please feel free to ask any questions or ask for help.
|
|
8
|
+
|
|
9
|
+
## Code of conduct
|
|
10
|
+
|
|
11
|
+
This project is governed by our [code of conduct](code_of_conduct.md).
|
|
12
|
+
By participating, you are expected to uphold this code.
|
|
13
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to community leaders responsible for enforcement.
|
|
14
|
+
Please open a [new security advisory notice](https://github.com/d33bs/zenodo-release-drift/security/advisories/new) (using defaults or "n/a" where unable to fill in the form) to privately notify us of any incidents of this nature.
|
|
15
|
+
|
|
16
|
+
## Development
|
|
17
|
+
|
|
18
|
+
This project leverages development environments managed by [uv](https://docs.astral.sh/uv/).
|
|
19
|
+
We use [pytest](https://docs.pytest.org/) for testing and [GitHub actions](https://docs.github.com/en/actions) for automated tests.
|
|
20
|
+
|
|
21
|
+
### Development setup
|
|
22
|
+
|
|
23
|
+
Perform the following steps to setup a Python development environment.
|
|
24
|
+
|
|
25
|
+
1. [Install Python](https://www.python.org/downloads/) (we recommend using [`pyenv`](https://github.com/pyenv/pyenv) or similar)
|
|
26
|
+
1. [Install uv](https://docs.astral.sh/uv/getting-started/installation/)
|
|
27
|
+
|
|
28
|
+
### Linting
|
|
29
|
+
|
|
30
|
+
Work added to this project is automatically checked using [pre-commit](https://pre-commit.com/) via [GitHub Actions](https://docs.github.com/en/actions).
|
|
31
|
+
Pre-commit can work alongside your local [git with git-hooks](https://pre-commit.com/index.html#3-install-the-git-hook-scripts)
|
|
32
|
+
|
|
33
|
+
After [installing pre-commit](https://pre-commit.com/#installation) within your development environment, the following command also can perform the same checks within your local development environment:
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
% pre-commit run --all-files
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
We use these same checks within our automated tests which are managed by [GitHub Actions workflows](https://docs.github.com/en/actions/using-workflows).
|
|
40
|
+
These automated tests generally must pass in order to merge work into this repository.
|
|
41
|
+
|
|
42
|
+
### Testing
|
|
43
|
+
|
|
44
|
+
Work added to this project is automatically tested using [pytest](https://docs.pytest.org/) via [GitHub Actions](https://docs.github.com/en/actions).
|
|
45
|
+
Pytest is installed through the uv environment for this project.
|
|
46
|
+
We recommend testing your work before opening pull requests with proposed changes.
|
|
47
|
+
|
|
48
|
+
You can run pytest on your work using the following example:
|
|
49
|
+
|
|
50
|
+
```sh
|
|
51
|
+
% uv run pytest
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Making changes to this repository
|
|
55
|
+
|
|
56
|
+
We welcome anyone to use [GitHub issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) (requires a GitHub login) or create [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) (to directly make changes within this repository) to modify content found within this repository.
|
|
57
|
+
|
|
58
|
+
Specifically, there are several ways to suggest or make changes to this repository:
|
|
59
|
+
|
|
60
|
+
1. Open a GitHub issue: https://github.com/d33bs/zenodo-release-drift/issues
|
|
61
|
+
1. Create a pull request from a forked branch of the repository
|
|
62
|
+
|
|
63
|
+
### Creating a pull request
|
|
64
|
+
|
|
65
|
+
### Pull requests
|
|
66
|
+
|
|
67
|
+
After you’ve decided to contribute code and have written it up, please file a pull request.
|
|
68
|
+
We specifically follow a [forked pull request model](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
|
|
69
|
+
Please create a fork of this repository, clone the fork, and then create a new, feature-specific branch.
|
|
70
|
+
Once you make the necessary changes on this branch, you should file a pull request to incorporate your changes into this (fork upstream) repository.
|
|
71
|
+
|
|
72
|
+
The content and description of your pull request are directly related to the speed at which we are able to review, approve, and merge your contribution.
|
|
73
|
+
To ensure an efficient review process please perform the following steps:
|
|
74
|
+
|
|
75
|
+
1. Follow all instructions in the [pull request template](https://github.com/d33bs/zenodo-release-drift/blob/main/.github/PULL_REQUEST_TEMPLATE.md)
|
|
76
|
+
1. Triple check that your pull request is adding _one_ specific feature or additional group of content.
|
|
77
|
+
Small, bite-sized pull requests move so much faster than large pull requests.
|
|
78
|
+
1. After submitting your pull request, ensure that your contribution passes all status checks (e.g. passes all tests)
|
|
79
|
+
|
|
80
|
+
Pull request review and approval is required by at least one project maintainer to merge.
|
|
81
|
+
We will do our best to review the code addition in a timely fashion.
|
|
82
|
+
Ensuring that you follow all steps above will increase our speed and ability to review.
|
|
83
|
+
We will check for accuracy, style, code coverage, and scope.
|
|
84
|
+
|
|
85
|
+
## Versioning
|
|
86
|
+
|
|
87
|
+
We use [`setuptools-scm`](https://github.com/pypa/setuptools-scm) to help version this software through [`PEP 440`](https://peps.python.org/pep-0440/) standards and [semver.org](https://semver.org/) standards.
|
|
88
|
+
Configuration for versioning is found within the `pyproject.toml` file.
|
|
89
|
+
All builds for packages include dynamic version data to help label distinct versions of the software.
|
|
90
|
+
`setuptools-scm` uses `git` tags to help distinguish version data.
|
|
91
|
+
We also use the `_version.py` file as a place to persist the version data for occaissions where the `git` history is unavailable or unwanted (this file is only present in package builds).
|
|
92
|
+
Versioning for the project is intended to align with GitHub Releases which provide `git` tag capabilities.
|
|
93
|
+
|
|
94
|
+
### Releases
|
|
95
|
+
|
|
96
|
+
We publish source code by using [GitHub Releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases) available [here](https://github.com/d33bs/zenodo-release-drift/releases).
|
|
97
|
+
|
|
98
|
+
#### Release Publishing Process
|
|
99
|
+
|
|
100
|
+
Several manual and automated steps are involved with publishing releases.
|
|
101
|
+
See below for an overview of how this works.
|
|
102
|
+
|
|
103
|
+
Notes about [semantic version](https://en.wikipedia.org/wiki/Software_versioning#Semantic_versioning) (semver) specifications: version specifications are controlled through [`setuptools-scm`](https://github.com/pypa/setuptools-scm) to create version data based on [git tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging) and commits.
|
|
104
|
+
Release git tags are automatically applied through [GitHub Releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases) and related inferred changes from [`release-drafter`](https://github.com/release-drafter/release-drafter).
|
|
105
|
+
|
|
106
|
+
1. Open a pull request and use a repository label for `release-<semver release type>` to label the pull request for visibility with [`release-drafter`](https://github.com/release-drafter/release-drafter).
|
|
107
|
+
1. On merging the pull request for the release, a [GitHub Actions workflow](https://docs.github.com/en/actions/using-workflows) defined in `draft-release.yml` leveraging [`release-drafter`](https://github.com/release-drafter/release-drafter) will draft a release for maintainers.
|
|
108
|
+
1. The draft GitHub release will include a version tag based on the GitHub PR label applied and `release-drafter`.
|
|
109
|
+
1. Make modifications as necessary to the draft GitHub release, then publish the release (the draft release does not normally need additional modifications).
|
|
110
|
+
1. On publishing the release, another GitHub Actions workflow defined in `publish-pypi.yml` will run to build and deploy the Python package to PyPI (utilizing the earlier modified `pyproject.toml` semantic version reference for labeling the release).
|
|
111
|
+
|
|
112
|
+
## Documentation
|
|
113
|
+
|
|
114
|
+
Documentation for this project is published using [Sphinx](https://www.sphinx-doc.org) with markdown and Jupyter notebook file compatibility provided by [myst-parser](https://myst-parser.readthedocs.io/en/latest/) and [myst-nb](https://myst-nb.readthedocs.io/en/latest/) to create a "documentation website" (also known as "docsite").
|
|
115
|
+
The docsite is hosted through [GitHub Pages](https://pages.github.com/) and deployed through automated [GitHub Actions](https://docs.github.com/en/actions) jobs which trigger on pushes to the main branch or the publishing of a new release on GitHub.
|
|
116
|
+
Documentation is versioned as outlined earlier sections covering versioning details to help ensure users are able to understand each release independently of one another.
|
|
117
|
+
|
|
118
|
+
It can sometimes be useful to test documentation builds locally before proposing changes within a pull request.
|
|
119
|
+
See below for some examples of how to build documentation locally.
|
|
120
|
+
|
|
121
|
+
```shell
|
|
122
|
+
# build single-version sphinx documentation
|
|
123
|
+
# (useful for troubleshooting potential issues)
|
|
124
|
+
uv run sphinx-build docs/src docs/build
|
|
125
|
+
|
|
126
|
+
# build multi-version sphinx documentation
|
|
127
|
+
# (used in production)
|
|
128
|
+
uv run sphinx-multiversion docs/src docs/build
|
|
129
|
+
```
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
BSD 3-Clause License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025, the Regents of the University of Colorado
|
|
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.
|