citeable 2026.2.25a0__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.
- citeable-2026.2.25a0/.github/dependabot.yml +14 -0
- citeable-2026.2.25a0/.github/workflows/linters.yml +27 -0
- citeable-2026.2.25a0/.github/workflows/release.yml +68 -0
- citeable-2026.2.25a0/.github/workflows/testing_develop.yml +54 -0
- citeable-2026.2.25a0/.gitignore +62 -0
- citeable-2026.2.25a0/.hgignore +45 -0
- citeable-2026.2.25a0/.sourcery.yaml +2 -0
- citeable-2026.2.25a0/LICENSE +28 -0
- citeable-2026.2.25a0/PKG-INFO +448 -0
- citeable-2026.2.25a0/README.md +429 -0
- citeable-2026.2.25a0/noxfile.py +30 -0
- citeable-2026.2.25a0/pyproject.toml +41 -0
- citeable-2026.2.25a0/ruff.toml +103 -0
- citeable-2026.2.25a0/src/citeable/__init__.py +40 -0
- citeable-2026.2.25a0/src/citeable/_entries.py +585 -0
- citeable-2026.2.25a0/src/citeable/_json.py +32 -0
- citeable-2026.2.25a0/src/citeable/_keys.py +59 -0
- citeable-2026.2.25a0/src/citeable/_parser.py +207 -0
- citeable-2026.2.25a0/src/citeable/_validate.py +37 -0
- citeable-2026.2.25a0/src/citeable/py.typed +0 -0
- citeable-2026.2.25a0/tests/test_entries.py +434 -0
- citeable-2026.2.25a0/tests/test_keys.py +109 -0
- citeable-2026.2.25a0/tests/test_parser.py +259 -0
- citeable-2026.2.25a0/tests/test_serialise.py +530 -0
- citeable-2026.2.25a0/tests/test_write.py +86 -0
- citeable-2026.2.25a0/uv.lock +546 -0
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
version: 2
|
|
2
|
+
updates:
|
|
3
|
+
- package-ecosystem: pip
|
|
4
|
+
directory: "/"
|
|
5
|
+
schedule:
|
|
6
|
+
interval: weekly
|
|
7
|
+
time: "19:00"
|
|
8
|
+
open-pull-requests-limit: 10
|
|
9
|
+
- package-ecosystem: "github-actions"
|
|
10
|
+
directory: "/"
|
|
11
|
+
schedule:
|
|
12
|
+
interval: "weekly"
|
|
13
|
+
time: "19:00"
|
|
14
|
+
open-pull-requests-limit: 10
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
name: Lint code using ruff
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
|
|
6
|
+
jobs:
|
|
7
|
+
linters:
|
|
8
|
+
runs-on: ubuntu-latest
|
|
9
|
+
if: github.repository == 'cogent3/citeable'
|
|
10
|
+
steps:
|
|
11
|
+
- uses: actions/checkout@v6
|
|
12
|
+
|
|
13
|
+
- name: Install uv
|
|
14
|
+
uses: astral-sh/setup-uv@v7
|
|
15
|
+
with:
|
|
16
|
+
enable-cache: true
|
|
17
|
+
cache-dependency-glob: "uv.lock"
|
|
18
|
+
|
|
19
|
+
- name: Format code using ruff
|
|
20
|
+
run: uv run nox -s fmt
|
|
21
|
+
- name: Commit changes
|
|
22
|
+
uses: EndBug/add-and-commit@v9
|
|
23
|
+
with:
|
|
24
|
+
author_name: ${{ github.actor }}
|
|
25
|
+
author_email: ${{ github.actor }}@users.noreply.github.com
|
|
26
|
+
message: "STY: pre-commit linting with ruff"
|
|
27
|
+
add: "."
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
name: Release
|
|
2
|
+
|
|
3
|
+
on: [workflow_dispatch]
|
|
4
|
+
|
|
5
|
+
jobs:
|
|
6
|
+
test:
|
|
7
|
+
name: "Test on Python ${{ matrix.python-version }} (${{ matrix.os }})"
|
|
8
|
+
runs-on: ${{ matrix.os }}
|
|
9
|
+
strategy:
|
|
10
|
+
matrix:
|
|
11
|
+
os: [ubuntu-latest, macos-latest, windows-latest]
|
|
12
|
+
python-version: ["3.11", "3.12", "3.13", "3.14"]
|
|
13
|
+
steps:
|
|
14
|
+
- uses: "actions/checkout@v6"
|
|
15
|
+
with:
|
|
16
|
+
fetch-depth: 0
|
|
17
|
+
|
|
18
|
+
- name: Install uv
|
|
19
|
+
uses: astral-sh/setup-uv@v7
|
|
20
|
+
with:
|
|
21
|
+
enable-cache: true
|
|
22
|
+
cache-dependency-glob: "uv.lock"
|
|
23
|
+
|
|
24
|
+
- name: "Run nox for ${{ matrix.python-version }}"
|
|
25
|
+
shell: bash
|
|
26
|
+
run: uv run nox -s "test-${{ matrix.python-version }}"
|
|
27
|
+
|
|
28
|
+
build:
|
|
29
|
+
name: Build wheel and sdist
|
|
30
|
+
needs: test
|
|
31
|
+
runs-on: ubuntu-latest
|
|
32
|
+
|
|
33
|
+
steps:
|
|
34
|
+
- uses: actions/checkout@v6
|
|
35
|
+
with:
|
|
36
|
+
fetch-depth: 0
|
|
37
|
+
|
|
38
|
+
- name: Install uv
|
|
39
|
+
uses: astral-sh/setup-uv@v7
|
|
40
|
+
|
|
41
|
+
- name: Build sdist and wheel
|
|
42
|
+
run: uv build
|
|
43
|
+
|
|
44
|
+
- name: Upload sdist and wheel
|
|
45
|
+
uses: actions/upload-artifact@v6
|
|
46
|
+
with:
|
|
47
|
+
name: citeable-wheel-sdist
|
|
48
|
+
path: |
|
|
49
|
+
./dist/*.whl
|
|
50
|
+
./dist/*.tar.gz
|
|
51
|
+
|
|
52
|
+
release:
|
|
53
|
+
name: Release to PyPI
|
|
54
|
+
needs: build
|
|
55
|
+
environment: pypi
|
|
56
|
+
runs-on: ubuntu-latest
|
|
57
|
+
permissions:
|
|
58
|
+
id-token: write
|
|
59
|
+
|
|
60
|
+
steps:
|
|
61
|
+
- name: Download sdist and wheel
|
|
62
|
+
uses: actions/download-artifact@v7
|
|
63
|
+
with:
|
|
64
|
+
name: citeable-wheel-sdist
|
|
65
|
+
path: ./dist
|
|
66
|
+
|
|
67
|
+
- name: Publish package distributions to PyPI
|
|
68
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
pull_request:
|
|
6
|
+
# NOTE:
|
|
7
|
+
# if changing python versions, also update versions in
|
|
8
|
+
# - release.yml
|
|
9
|
+
# - noxfile.py
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
tests:
|
|
13
|
+
name: "Python ${{ matrix.python-version }} (${{ matrix.os }})"
|
|
14
|
+
runs-on: ${{ matrix.os }}
|
|
15
|
+
|
|
16
|
+
strategy:
|
|
17
|
+
matrix:
|
|
18
|
+
os: [ubuntu-latest, macos-latest, windows-latest]
|
|
19
|
+
python-version: ["3.11", "3.14"]
|
|
20
|
+
|
|
21
|
+
steps:
|
|
22
|
+
- uses: "actions/checkout@v6"
|
|
23
|
+
with:
|
|
24
|
+
fetch-depth: 0
|
|
25
|
+
|
|
26
|
+
- name: Install uv
|
|
27
|
+
uses: astral-sh/setup-uv@v7
|
|
28
|
+
with:
|
|
29
|
+
enable-cache: true
|
|
30
|
+
cache-dependency-glob: "uv.lock"
|
|
31
|
+
|
|
32
|
+
- name: "Run nox for ${{ matrix.python-version }}"
|
|
33
|
+
shell: bash
|
|
34
|
+
run: |
|
|
35
|
+
cov="--cov-report lcov:lcov-${{matrix.os}}-${{matrix.python-version}}.lcov --cov-report term --cov-append --cov citeable"
|
|
36
|
+
uv run nox -s "test-${{ matrix.python-version }}" -- $cov
|
|
37
|
+
|
|
38
|
+
type_check:
|
|
39
|
+
name: Type Check
|
|
40
|
+
runs-on: ubuntu-latest
|
|
41
|
+
|
|
42
|
+
steps:
|
|
43
|
+
- uses: actions/checkout@v6
|
|
44
|
+
with:
|
|
45
|
+
fetch-depth: 0
|
|
46
|
+
|
|
47
|
+
- name: Install uv
|
|
48
|
+
uses: astral-sh/setup-uv@v7
|
|
49
|
+
with:
|
|
50
|
+
enable-cache: true
|
|
51
|
+
cache-dependency-glob: "uv.lock"
|
|
52
|
+
|
|
53
|
+
- name: "Run Type Checking"
|
|
54
|
+
run: uv run mypy src/citeable --strict
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
*.py[cod]
|
|
2
|
+
|
|
3
|
+
# C extensions
|
|
4
|
+
*.so
|
|
5
|
+
|
|
6
|
+
# Packages
|
|
7
|
+
*.egg
|
|
8
|
+
*.egg-info
|
|
9
|
+
dist
|
|
10
|
+
build
|
|
11
|
+
eggs
|
|
12
|
+
parts
|
|
13
|
+
bin
|
|
14
|
+
var
|
|
15
|
+
sdist
|
|
16
|
+
develop-eggs
|
|
17
|
+
.installed.cfg
|
|
18
|
+
lib
|
|
19
|
+
lib64
|
|
20
|
+
doc/_build
|
|
21
|
+
|
|
22
|
+
# docker stuff
|
|
23
|
+
.devcontainer/*
|
|
24
|
+
|
|
25
|
+
# Installer logs
|
|
26
|
+
pip-log.txt
|
|
27
|
+
|
|
28
|
+
# Unit test / coverage reports
|
|
29
|
+
.mypy*
|
|
30
|
+
**/.mypy_cache/*
|
|
31
|
+
.coverage*
|
|
32
|
+
.tox
|
|
33
|
+
.nox
|
|
34
|
+
coverage.xml
|
|
35
|
+
junit-*.xml
|
|
36
|
+
nosetests.xml
|
|
37
|
+
tests/draw_results
|
|
38
|
+
lcov*.info
|
|
39
|
+
.ruff_cache/*
|
|
40
|
+
|
|
41
|
+
# Translations
|
|
42
|
+
*.mo
|
|
43
|
+
|
|
44
|
+
# Mr Developer
|
|
45
|
+
.mr.developer.cfg
|
|
46
|
+
.project
|
|
47
|
+
.pydevproject
|
|
48
|
+
.idea/*
|
|
49
|
+
.DS_Store
|
|
50
|
+
__pycache__
|
|
51
|
+
*.code-workspace
|
|
52
|
+
*.wpr
|
|
53
|
+
*.wpu
|
|
54
|
+
.vscode/*
|
|
55
|
+
venv*
|
|
56
|
+
.venv*
|
|
57
|
+
working/
|
|
58
|
+
*.ipynb
|
|
59
|
+
*.ipynb_checkpoints/
|
|
60
|
+
|
|
61
|
+
# vi
|
|
62
|
+
.*.swp
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
syntax:glob
|
|
2
|
+
.svn
|
|
3
|
+
*.pyc
|
|
4
|
+
*.pyo
|
|
5
|
+
*.so
|
|
6
|
+
*.o
|
|
7
|
+
*.DS_Store
|
|
8
|
+
*.tmproj
|
|
9
|
+
*.rej
|
|
10
|
+
*.orig
|
|
11
|
+
*.wpr
|
|
12
|
+
*.pdf
|
|
13
|
+
_build/*
|
|
14
|
+
build
|
|
15
|
+
*htmlcov*
|
|
16
|
+
*.idea
|
|
17
|
+
draw_results
|
|
18
|
+
*.coverage*
|
|
19
|
+
*egg-info*
|
|
20
|
+
*.wpu
|
|
21
|
+
.cache*
|
|
22
|
+
*taskpaper
|
|
23
|
+
*.ipynb
|
|
24
|
+
*.ipynb_checkpoints*
|
|
25
|
+
*.sublime*
|
|
26
|
+
*.patch
|
|
27
|
+
*.pytest_cache
|
|
28
|
+
*.tox
|
|
29
|
+
*.nox
|
|
30
|
+
*.vscode
|
|
31
|
+
*.code-workspace
|
|
32
|
+
coverage.xml
|
|
33
|
+
__pycache__
|
|
34
|
+
junit-*.xml
|
|
35
|
+
doc/draw*
|
|
36
|
+
dist/*
|
|
37
|
+
working/*
|
|
38
|
+
lcov*.info
|
|
39
|
+
.ruff_cache/*
|
|
40
|
+
.devcontainer/*
|
|
41
|
+
hg_old*zip
|
|
42
|
+
hg_old/*
|
|
43
|
+
venv*
|
|
44
|
+
.venv*
|
|
45
|
+
.mypy*
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
BSD 3-Clause License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026, Gavin Huttley
|
|
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.
|