Skip to content

Commit 80e4a45

Browse files
authored
docs: add CITATION.cff file, link to CITATION text in README (#551)
* Add CITATION.cff file * Add Citation section to README.md
1 parent 98f121f commit 80e4a45

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

CITATION.cff

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
cff-version: 1.2.0
2+
message: 'If you wish to cite the "great-tables" package use:'
3+
type: software
4+
license: MIT
5+
title: "great-tables: Make awesome display tables using Python."
6+
version: 0.14.0
7+
abstract:
8+
Build display tables from tabular data with an easy-to-use set of methods.
9+
With its progressive approach, we can construct display tables with a cohesive set
10+
of table parts. Table values can be formatted using any of the included formatting
11+
functions. Cell styles can be precisely added through a location targeting system. The way
12+
in which Great Tables handles things for you means that you don't often have to worry about
13+
the fine details.
14+
authors:
15+
- family-names: Iannone
16+
given-names: Richard
17+
18+
orcid: https://orcid.org/0000-0003-3925-190X
19+
- family-names: Michael
20+
given-names: Chow
21+
22+
repository: https://pypi.org/project/great-tables/
23+
repository-code: https://github.com/posit-dev/great-tables
24+
url: https://posit-dev.github.io/great-tables/
25+
contact:
26+
- family-names: Iannone
27+
given-names: Richard
28+
29+
orcid: https://orcid.org/0000-0003-3925-190X

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,20 @@ Please note that the **Great Tables** project is released with a [contributor co
104104

105105
© Posit Software, PBC.
106106

107+
## Citation
108+
109+
If you use **Great Tables** in your research/project/product, we would appreciate a citation to the package. You can cite the package using the following BibTeX entry:
110+
111+
```bibtex
112+
@software{Iannone_great_tables,
113+
author = {Iannone, Richard and Chow, Michael},
114+
license = {MIT},
115+
title = {{great-tables: Make awesome display tables using Python.}},
116+
url = {https://github.com/posit-dev/great-tables},
117+
version = {0.14.0}
118+
}
119+
```
120+
107121
## 🏛️ Governance
108122

109123
This project is primarily maintained by [Rich Iannone](https://twitter.com/riannone) and [Michael Chow](https://twitter.com/chowthedog).

0 commit comments

Comments
 (0)