citecheck: like typechecks, but for citations 📖⛓️
Quick example
Consider this example (all authors and quantities are fictitious):
- Doe (2021) published a method for estimating $V_t$ as a function of $q_p$ and $t$.
- Bloggs (2023) published a method for estimating $R_m$ as a function of $V_t$ and $\rho$, with the explicit requirement that $V_t$ be estimated using the method of Doe (2021) in particular.
The goal for citecheck is that you could implement this as follows:
from citecheck import enforcecite, Cite
@enforcecite
def calc_vt_doe2021(
qt: float,
t: float
) -> Annotated[float, Cite("doe2021")]:
...
@enforcecite
def calc_rm_bloggs2023(
vt: Annotated[float, Cite("doe2021")],
rho: float
) -> Annotated[float, Cite("bloggs2023")]:
...
Now, if we try to pass a value for $V_t$ that was not estimated using the method of Doe (2021), we would get an error:
calc_rm_bloggs2023(vt=1.0, rho=1.0) # Error
calc_rm_bloggs2023(vt=calc_vt_doe2021(1.0, 1.0), rho=1.0) # OK
citecheck is still in development, but this is the general idea.
When to use citecheck
You should consider using citecheck when you are implementing functions corresponding to equations or methodologies in multiple papers which refer to one another.
Getting Started with Development
Use Linux, install pyenv, and then run the setup
script:
source .\scripts\dev-setup.sh
1 maintainer
Metadata
1 maintainer
Release files for citecheck 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| citecheck-0.3.0.tar.gz | 27.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| citecheck-0.3.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 38.7 kB
Release files / citecheck-0.3.0.tar.gz
| Download URL | citecheck-0.3.0.tar.gz |
|---|---|
| Size | 27.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
28f9a3b6768fdc9f76319cf0f5cec0d348a7bf8ea5b12224b5d3cd27208b428d
|
|
BLAKE2b-256 checksum How to use checksums |
9d0448441ee3270ad66d83f60f38774337a5dff13313d93fa5557b5331b21855
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.8.16
|
Release files / citecheck-0.3.0-py2.py3-none-any.whl
| Download URL | citecheck-0.3.0-py2.py3-none-any.whl |
|---|---|
| Size | 11.6 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
41b6388ecd5e29c51ed89c955bd0210fbc2c9bc7fcb61b254fafe64de2c05e97
|
|
BLAKE2b-256 checksum How to use checksums |
6dac318b8dfa6fa4de882dd8ac4d2ce576c6c0070edde99fb189ae2f686a1217
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.8.16
|
