philoch-bib-sdk 0.1.1__py3-none-any.whl
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.
- philoch_bib_sdk/__init__.py +0 -0
- philoch_bib_sdk/logic/literals.py +86 -0
- philoch_bib_sdk/logic/models.py +359 -0
- philoch_bib_sdk/py.typed +0 -0
- philoch_bib_sdk-0.1.1.dist-info/LICENSE +21 -0
- philoch_bib_sdk-0.1.1.dist-info/METADATA +21 -0
- philoch_bib_sdk-0.1.1.dist-info/RECORD +8 -0
- philoch_bib_sdk-0.1.1.dist-info/WHEEL +4 -0
|
File without changes
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
from typing import Literal
|
|
2
|
+
|
|
3
|
+
type TBibTeXEntryType = Literal[
|
|
4
|
+
"",
|
|
5
|
+
"article",
|
|
6
|
+
"book",
|
|
7
|
+
"incollection",
|
|
8
|
+
"inproceedings",
|
|
9
|
+
"mastersthesis",
|
|
10
|
+
"misc",
|
|
11
|
+
"phdthesis",
|
|
12
|
+
"proceedings",
|
|
13
|
+
"techreport",
|
|
14
|
+
"unpublished",
|
|
15
|
+
]
|
|
16
|
+
|
|
17
|
+
type TPubState = Literal[
|
|
18
|
+
"",
|
|
19
|
+
"unpub",
|
|
20
|
+
"inwork",
|
|
21
|
+
"submitted",
|
|
22
|
+
"published",
|
|
23
|
+
"forthcoming",
|
|
24
|
+
]
|
|
25
|
+
|
|
26
|
+
type TLanguageID = Literal[
|
|
27
|
+
"",
|
|
28
|
+
"catalan",
|
|
29
|
+
"czech",
|
|
30
|
+
"danish",
|
|
31
|
+
"dutch",
|
|
32
|
+
"english",
|
|
33
|
+
"french",
|
|
34
|
+
"greek",
|
|
35
|
+
"italian",
|
|
36
|
+
"latin",
|
|
37
|
+
"lithuanian",
|
|
38
|
+
"ngerman",
|
|
39
|
+
"polish",
|
|
40
|
+
"portuguese",
|
|
41
|
+
"romanian",
|
|
42
|
+
"russian",
|
|
43
|
+
"slovak",
|
|
44
|
+
"spanish",
|
|
45
|
+
"swedish",
|
|
46
|
+
"unknown",
|
|
47
|
+
]
|
|
48
|
+
|
|
49
|
+
type TEpoch = Literal[
|
|
50
|
+
"",
|
|
51
|
+
"ancient-philosophy",
|
|
52
|
+
"ancient-scientists",
|
|
53
|
+
"austrian-philosophy",
|
|
54
|
+
"british-idealism",
|
|
55
|
+
"classics",
|
|
56
|
+
"contemporaries",
|
|
57
|
+
"contemporary-scientists",
|
|
58
|
+
"continental-philosophy",
|
|
59
|
+
"critical-theory",
|
|
60
|
+
"cynics",
|
|
61
|
+
"enlightenment",
|
|
62
|
+
"existentialism",
|
|
63
|
+
"exotic-philosophy",
|
|
64
|
+
"german-idealism",
|
|
65
|
+
"german-rationalism",
|
|
66
|
+
"gestalt-psychology",
|
|
67
|
+
"hermeneutics",
|
|
68
|
+
"islamic-philosophy",
|
|
69
|
+
"mathematicians",
|
|
70
|
+
"medieval-philosophy",
|
|
71
|
+
"modern-philosophy",
|
|
72
|
+
"modern-scientists",
|
|
73
|
+
"neokantianism",
|
|
74
|
+
"neo-kantianism",
|
|
75
|
+
"neoplatonism",
|
|
76
|
+
"new-realism",
|
|
77
|
+
"ordinary-language-philosophy",
|
|
78
|
+
"phenomenology",
|
|
79
|
+
"polish-logic",
|
|
80
|
+
"pragmatism",
|
|
81
|
+
"presocratics",
|
|
82
|
+
"renaissance",
|
|
83
|
+
"stoics",
|
|
84
|
+
"theologians",
|
|
85
|
+
"vienna-circle",
|
|
86
|
+
]
|
|
@@ -0,0 +1,359 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
from typing import Tuple
|
|
3
|
+
import attrs
|
|
4
|
+
|
|
5
|
+
from philoch_bib_sdk.logic.literals import TBibTeXEntryType, TEpoch, TLanguageID, TPubState
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
############
|
|
9
|
+
# Base Renderables
|
|
10
|
+
############
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
@attrs.define(frozen=True, slots=True)
|
|
14
|
+
class BaseRenderable:
|
|
15
|
+
"""
|
|
16
|
+
Base class for renderable objects, that contain LaTeX code, and possibly a unicode representation of it.
|
|
17
|
+
|
|
18
|
+
Args:
|
|
19
|
+
text: str = ""
|
|
20
|
+
text_latex: str = ""
|
|
21
|
+
id: int = -1
|
|
22
|
+
"""
|
|
23
|
+
|
|
24
|
+
text: str = ""
|
|
25
|
+
text_latex: str = ""
|
|
26
|
+
id: int = -1
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
@attrs.define(frozen=True, slots=True)
|
|
30
|
+
class BaseNamedRenderable:
|
|
31
|
+
"""
|
|
32
|
+
Base class for renderable, named, objects, that contain LaTeX code, and possibly a unicode representation of it.
|
|
33
|
+
|
|
34
|
+
Args:
|
|
35
|
+
name: str
|
|
36
|
+
name_latex: str | None = None
|
|
37
|
+
id: int | None = None
|
|
38
|
+
"""
|
|
39
|
+
|
|
40
|
+
name: str = ""
|
|
41
|
+
name_latex: str = ""
|
|
42
|
+
id: int = -1
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
############
|
|
46
|
+
# Author
|
|
47
|
+
############
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
@attrs.define(frozen=True, slots=True)
|
|
51
|
+
class Author:
|
|
52
|
+
"""
|
|
53
|
+
An author of a publication.
|
|
54
|
+
|
|
55
|
+
Args:
|
|
56
|
+
given_name: str = ""
|
|
57
|
+
family_name: str = ""
|
|
58
|
+
given_name_latex: str = ""
|
|
59
|
+
family_name_latex: str = ""
|
|
60
|
+
publications: List[BibItem] = []
|
|
61
|
+
id: int = -1
|
|
62
|
+
"""
|
|
63
|
+
|
|
64
|
+
given_name: str = ""
|
|
65
|
+
family_name: str = ""
|
|
66
|
+
given_name_latex: str = ""
|
|
67
|
+
family_name_latex: str = ""
|
|
68
|
+
famous_name: str = ""
|
|
69
|
+
publications: Tuple[BibItem, ...] = ()
|
|
70
|
+
id: int = -1
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
############
|
|
74
|
+
# Journal
|
|
75
|
+
############
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
@attrs.define(frozen=True, slots=True)
|
|
79
|
+
class Journal:
|
|
80
|
+
"""
|
|
81
|
+
A journal that publishes publications.
|
|
82
|
+
|
|
83
|
+
Args:
|
|
84
|
+
name: str = ""
|
|
85
|
+
name_latex: str = ""
|
|
86
|
+
issn_print: str = ""
|
|
87
|
+
issn_electronic: str = ""
|
|
88
|
+
id: int = -1
|
|
89
|
+
"""
|
|
90
|
+
|
|
91
|
+
name: str = ""
|
|
92
|
+
name_latex: str = ""
|
|
93
|
+
issn_print: str = ""
|
|
94
|
+
issn_electronic: str = ""
|
|
95
|
+
id: int = -1
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
############
|
|
99
|
+
# Note
|
|
100
|
+
############
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
@attrs.define(frozen=True, slots=True)
|
|
104
|
+
class Note(BaseRenderable):
|
|
105
|
+
"""
|
|
106
|
+
Notes (metadata) about a publication.
|
|
107
|
+
|
|
108
|
+
Args:
|
|
109
|
+
text: str = ""
|
|
110
|
+
text_latex: str = ""
|
|
111
|
+
id: int = -1
|
|
112
|
+
"""
|
|
113
|
+
|
|
114
|
+
pass
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
############
|
|
118
|
+
# Keywords
|
|
119
|
+
############
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
@attrs.define(frozen=True, slots=True)
|
|
123
|
+
class Keyword:
|
|
124
|
+
"""
|
|
125
|
+
Keyword of a publication.
|
|
126
|
+
|
|
127
|
+
Args:
|
|
128
|
+
name: str = ""
|
|
129
|
+
id: int = -1
|
|
130
|
+
"""
|
|
131
|
+
|
|
132
|
+
name: str = ""
|
|
133
|
+
id: int = -1
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
@attrs.define(frozen=True, slots=True)
|
|
137
|
+
class Keywords:
|
|
138
|
+
level1: Keyword = Keyword()
|
|
139
|
+
level2: Keyword = Keyword()
|
|
140
|
+
level3: Keyword = Keyword()
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
############
|
|
144
|
+
# Series, Institution, School, Publisher, Type
|
|
145
|
+
############
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
@attrs.define(frozen=True, slots=True)
|
|
149
|
+
class Series(BaseNamedRenderable):
|
|
150
|
+
"""
|
|
151
|
+
A series of publications.
|
|
152
|
+
|
|
153
|
+
Args:
|
|
154
|
+
name: str = ""
|
|
155
|
+
name_latex: str = ""
|
|
156
|
+
id: int = -1
|
|
157
|
+
"""
|
|
158
|
+
|
|
159
|
+
pass
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
@attrs.define(frozen=True, slots=True)
|
|
163
|
+
class Institution(BaseNamedRenderable):
|
|
164
|
+
"""
|
|
165
|
+
An institution that publishes publications.
|
|
166
|
+
|
|
167
|
+
Args:
|
|
168
|
+
name: str = ""
|
|
169
|
+
name_latex: str = ""
|
|
170
|
+
id: int = -1
|
|
171
|
+
"""
|
|
172
|
+
|
|
173
|
+
pass
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
@attrs.define(frozen=True, slots=True)
|
|
177
|
+
class School(BaseNamedRenderable):
|
|
178
|
+
"""
|
|
179
|
+
A school that publishes publications.
|
|
180
|
+
|
|
181
|
+
Args:
|
|
182
|
+
name: str = ""
|
|
183
|
+
name_latex: str = ""
|
|
184
|
+
id: int = -1
|
|
185
|
+
"""
|
|
186
|
+
|
|
187
|
+
pass
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
@attrs.define(frozen=True, slots=True)
|
|
191
|
+
class Publisher(BaseNamedRenderable):
|
|
192
|
+
"""
|
|
193
|
+
A publisher of publications.
|
|
194
|
+
|
|
195
|
+
Args:
|
|
196
|
+
name: str = ""
|
|
197
|
+
name_latex: str = ""
|
|
198
|
+
id: int = -1
|
|
199
|
+
"""
|
|
200
|
+
|
|
201
|
+
pass
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
@attrs.define(frozen=True, slots=True)
|
|
205
|
+
class Type(BaseNamedRenderable):
|
|
206
|
+
"""
|
|
207
|
+
A type of publication.
|
|
208
|
+
|
|
209
|
+
Args:
|
|
210
|
+
name: str = ""
|
|
211
|
+
name_latex: str = ""
|
|
212
|
+
id: int = -1
|
|
213
|
+
"""
|
|
214
|
+
|
|
215
|
+
pass
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
############
|
|
219
|
+
# BibItem
|
|
220
|
+
############
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
@attrs.define(frozen=True, slots=True)
|
|
224
|
+
class BibKey:
|
|
225
|
+
"""
|
|
226
|
+
A unique identifier for a publication.
|
|
227
|
+
|
|
228
|
+
Args:
|
|
229
|
+
first_author: str = ""
|
|
230
|
+
year: int | None = None
|
|
231
|
+
pub_status: TPubState = "published"
|
|
232
|
+
other_authors: str = ""
|
|
233
|
+
et_al: bool = False
|
|
234
|
+
year_suffix
|
|
235
|
+
"""
|
|
236
|
+
|
|
237
|
+
first_author: str
|
|
238
|
+
other_authors: str = ""
|
|
239
|
+
year: int | None = None
|
|
240
|
+
pub_status: TPubState = ""
|
|
241
|
+
year_suffix: str = ""
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
@attrs.define(frozen=True, slots=True)
|
|
245
|
+
class BibItemDate:
|
|
246
|
+
"""
|
|
247
|
+
Year of a publication.
|
|
248
|
+
|
|
249
|
+
Example:
|
|
250
|
+
BibItemDate(year=2021, year_revised=2022) represents `2021/2022`.
|
|
251
|
+
BibItemDate(year=2021, month=1, day=1) represents `2021-01-01`.
|
|
252
|
+
BibItemDate(forthcoming=True) represents `forthcoming`.
|
|
253
|
+
|
|
254
|
+
Args:
|
|
255
|
+
year: int | None = None
|
|
256
|
+
year_revised: int | None = None
|
|
257
|
+
month: int | None = None
|
|
258
|
+
day: int | None = None
|
|
259
|
+
forthcoming: bool | None = None
|
|
260
|
+
"""
|
|
261
|
+
|
|
262
|
+
year: int | None = None
|
|
263
|
+
year_revised: int | None = None
|
|
264
|
+
month: int | None = None
|
|
265
|
+
day: int | None = None
|
|
266
|
+
forthcoming: bool = False
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
@attrs.define(frozen=True, slots=True)
|
|
270
|
+
class PagePair:
|
|
271
|
+
"""
|
|
272
|
+
Page numbers of a publication. Can be a range, roman numerals, or a single page.
|
|
273
|
+
|
|
274
|
+
Args:
|
|
275
|
+
start: str
|
|
276
|
+
end: str | None = None
|
|
277
|
+
"""
|
|
278
|
+
|
|
279
|
+
start: str
|
|
280
|
+
end: str = ""
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
@attrs.define(frozen=True, slots=True)
|
|
284
|
+
class IssueTitle(BaseRenderable):
|
|
285
|
+
"""
|
|
286
|
+
Title of an issue of a publication.
|
|
287
|
+
|
|
288
|
+
Args:
|
|
289
|
+
text: str
|
|
290
|
+
text_latex: str | None = None
|
|
291
|
+
id: int | None = None
|
|
292
|
+
"""
|
|
293
|
+
|
|
294
|
+
pass
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
@attrs.define(frozen=True, slots=True)
|
|
298
|
+
class BibItem:
|
|
299
|
+
"""
|
|
300
|
+
Bibliographic item type. All attributes are optional.
|
|
301
|
+
|
|
302
|
+
Args:
|
|
303
|
+
|
|
304
|
+
"""
|
|
305
|
+
|
|
306
|
+
_to_do: str = ""
|
|
307
|
+
_change_request: str = ""
|
|
308
|
+
entry_type: TBibTeXEntryType = ""
|
|
309
|
+
bibkey: BibKey | None = None
|
|
310
|
+
author: Tuple[Author, ...] = ()
|
|
311
|
+
editor: Tuple[Author, ...] = ()
|
|
312
|
+
options: Tuple[str, ...] = ()
|
|
313
|
+
shorthand: str = ""
|
|
314
|
+
date: BibItemDate | None = None
|
|
315
|
+
pubstate: TPubState | None = None
|
|
316
|
+
title: str = ""
|
|
317
|
+
_title_unicode: str = ""
|
|
318
|
+
booktitle: str = ""
|
|
319
|
+
crossref: str = ""
|
|
320
|
+
journal: Journal | None = None
|
|
321
|
+
volume: str = ""
|
|
322
|
+
number: str = ""
|
|
323
|
+
pages: Tuple[PagePair, ...] = ()
|
|
324
|
+
eid: str = ""
|
|
325
|
+
series: Series | None = None
|
|
326
|
+
address: str = ""
|
|
327
|
+
institution: str = ""
|
|
328
|
+
school: str = ""
|
|
329
|
+
publisher: Publisher | None = None
|
|
330
|
+
type: Type | None = None
|
|
331
|
+
edition: str = ""
|
|
332
|
+
note: Note | None = None
|
|
333
|
+
issuetitle: IssueTitle | None = None
|
|
334
|
+
guesteditor: Tuple[Author, ...] = ()
|
|
335
|
+
further_note: Note | None = None
|
|
336
|
+
urn: str = ""
|
|
337
|
+
eprint: str = ""
|
|
338
|
+
doi: str = ""
|
|
339
|
+
url: str = ""
|
|
340
|
+
_kws: Keywords = Keywords()
|
|
341
|
+
_epoch: TEpoch = ""
|
|
342
|
+
_person: Author | None = None
|
|
343
|
+
_comm_for_profile_bib: str = ""
|
|
344
|
+
langid: TLanguageID = ""
|
|
345
|
+
_lang_det: str = ""
|
|
346
|
+
_further_refs: Tuple[BibKey, ...] = ()
|
|
347
|
+
_depends_on: Tuple[BibKey, ...] = ()
|
|
348
|
+
dltc_num: int | None = None
|
|
349
|
+
_spec_interest: str = ""
|
|
350
|
+
_note_perso: Note | None = None
|
|
351
|
+
_note_stock: Note | None = None
|
|
352
|
+
_note_status: Note | None = None
|
|
353
|
+
_num_in_work: str = ""
|
|
354
|
+
_num_in_work_coll: int | None = None
|
|
355
|
+
_num_coll: int | None = None
|
|
356
|
+
_dltc_copyediting_note: str = ""
|
|
357
|
+
_note_missing: str = ""
|
|
358
|
+
_num_sort: int = 0
|
|
359
|
+
_bib_info_source: str = ""
|
philoch_bib_sdk/py.typed
ADDED
|
File without changes
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Philosophie.ch
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
Metadata-Version: 2.3
|
|
2
|
+
Name: philoch-bib-sdk
|
|
3
|
+
Version: 0.1.1
|
|
4
|
+
Summary: Standard development kit for the Philosophie Bibliography project
|
|
5
|
+
License: MIT
|
|
6
|
+
Author: Luis Alejandro Bordo García
|
|
7
|
+
Author-email: luis.bordo@philosophie.ch
|
|
8
|
+
Maintainer: Luis Alejandro Bordo García
|
|
9
|
+
Maintainer-email: tech@philosophie.ch
|
|
10
|
+
Requires-Python: >=3.13
|
|
11
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
14
|
+
Requires-Dist: aletk (>=0.1.6,<0.2.0)
|
|
15
|
+
Requires-Dist: attrs (>=25.3.0,<26.0.0)
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
|
|
18
|
+
# Philosophie.ch Bibliography SDK
|
|
19
|
+
|
|
20
|
+
This repository contains the standard development kit for the bibliography project of the [Philosophie.ch](https://philosophie.ch) association.
|
|
21
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
philoch_bib_sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
2
|
+
philoch_bib_sdk/logic/literals.py,sha256=cyoS4Bs9vN35fMkKESlbgLV3YfnRpviZSs4es76t71o,1512
|
|
3
|
+
philoch_bib_sdk/logic/models.py,sha256=b0O7zUP8lzco9Csq5mphGeS2t6Bjyc3LgLELYb-uYt0,7109
|
|
4
|
+
philoch_bib_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
5
|
+
philoch_bib_sdk-0.1.1.dist-info/LICENSE,sha256=nplGobji9gkYmJxDBbBz2SKjZY27SUaqhqKkpUB-C30,1070
|
|
6
|
+
philoch_bib_sdk-0.1.1.dist-info/METADATA,sha256=orwlKmm40nAh_gynpNl6XS-gEiJ2eTrqzCpqG246YCI,776
|
|
7
|
+
philoch_bib_sdk-0.1.1.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
|
|
8
|
+
philoch_bib_sdk-0.1.1.dist-info/RECORD,,
|