Repository navigation
Add CITATION.cff and a Citation section - #46
Merged
Merged
Conversation
Authors are Arcade Data Ltd (alias ArcadeData, as REUSE.toml names it) and Taewoon Kim, who is also the contact. No version or date-released: this repository has made no release yet, and the wheel version is derived from the engine jar at build time. No DOI: Zenodo is left to ArcadeData. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
CITATION.cff(CFF 1.2.0) so GitHub shows "Cite this repository", and a two-line Citation section in the README. This is the "CITATION.cff only" decision of 2026-10-25: no Zenodo for now.title: ArcadeDB Python,type: software,license: Apache-2.0,repository-code: https://github.com/ArcadeData/arcadedb-python,url: https://arcadedb.com.REUSE.tomluses; aliasArcadeData, the GitHub org) and Taewoon Kim. Taewoon Kim is also thecontact(maintainer).versionand nodate-released, on purpose: this repository has made no release yet (the first is 26.11.1), and the wheel version is derived from the engine jar at build time (pyproject.tomlholds the placeholder0.0.0), so a number written here would go stale. A comment in the file says to add both when a release is cut. Nothing inscripts/check_version.pyor the release workflow reads this file.Zenodo
Left to ArcadeData. Enabling it needs an ArcadeData org owner to approve the Zenodo OAuth app, and it would create a new concept DOI. There is no DOI in the file, and the README says so. If ArcadeData enables Zenodo later, the DOI goes into
identifiershere.Not added: a
preferred-citationfor the SciPy 2026 paper and the earlier software record (concept DOI ofhumemai/arcadedb-embedded-python). Both are possible follow-ups once the paper is citable.Checks run locally
uvx cffconvert --validate -i CITATION.cff: "Citation metadata are valid according to schema version 1.2.0." (An earlier draft with acopyright:key, copied from ArcadeData/arcadedb'sCITATION.cff, failed this check, so the key is not here. That file in ArcadeData/arcadedb has the same problem.)uvx cffconvert -f bibtexand-f apalike: both render.pre-commit run --files CITATION.cff README.md: passes.python3 scripts/check_no_embedded_name.py: passes.🤖 Generated with Claude Code