Skip to content

Commit

Permalink
docs: add CITATION.cff file, link to CITATION text in README (#551)
Browse files Browse the repository at this point in the history
* Add CITATION.cff file

* Add Citation section to README.md
  • Loading branch information
rich-iannone authored Dec 3, 2024
1 parent 98f121f commit 80e4a45
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
cff-version: 1.2.0
message: 'If you wish to cite the "great-tables" package use:'
type: software
license: MIT
title: "great-tables: Make awesome display tables using Python."
version: 0.14.0
abstract:
Build display tables from tabular data with an easy-to-use set of methods.
With its progressive approach, we can construct display tables with a cohesive set
of table parts. Table values can be formatted using any of the included formatting
functions. Cell styles can be precisely added through a location targeting system. The way
in which Great Tables handles things for you means that you don't often have to worry about
the fine details.
authors:
- family-names: Iannone
given-names: Richard
email: [email protected]
orcid: https://orcid.org/0000-0003-3925-190X
- family-names: Michael
given-names: Chow
email: [email protected]
repository: https://pypi.org/project/great-tables/
repository-code: https://github.com/posit-dev/great-tables
url: https://posit-dev.github.io/great-tables/
contact:
- family-names: Iannone
given-names: Richard
email: [email protected]
orcid: https://orcid.org/0000-0003-3925-190X
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,20 @@ Please note that the **Great Tables** project is released with a [contributor co

© Posit Software, PBC.

## Citation

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:

```bibtex
@software{Iannone_great_tables,
author = {Iannone, Richard and Chow, Michael},
license = {MIT},
title = {{great-tables: Make awesome display tables using Python.}},
url = {https://github.com/posit-dev/great-tables},
version = {0.14.0}
}
```

## 🏛️ Governance

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

0 comments on commit 80e4a45

Please sign in to comment.