Skip to content

Commit

Permalink
add CITATION
Browse files Browse the repository at this point in the history
  • Loading branch information
claromes committed Jun 25, 2024
1 parent 16f9997 commit 4aabc2a
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 1 deletion.
42 changes: 42 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Wayback Tweets
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Clarissa
family-names: Mendes
email: [email protected]
identifiers:
- type: doi
value: 10.5281/zenodo.12528448
description: The concept DOI of the work.
- type: url
value: "https://pypi.org/project/waybacktweets/"
description: Python Package Index.
- type: url
value: "https://claromes.github.io/waybacktweets/"
description: Documentation.
repository-code: "https://github.com/claromes/waybacktweets"
url: "https://claromes.github.io/waybacktweets"
abstract: >-
Retrieves archived tweets CDX data from the Wayback
Machine, performs necessary parsing, and saves the data in
HTML (for easy viewing of the tweets using the iframe
tag), CSV, and JSON formats.
keywords:
- Twitter
- Wayback Machine
- Tweets
- Python
- OSINT
- SOCMINT
- X
license: GPL-3.0
commit: 16f9997a8e2e2b87932ca061bf5731cd65d1d588
version: 1.0a5
date-released: "2024-06-24"
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Wayback Tweets

[![PyPI](https://img.shields.io/pypi/v/waybacktweets)](https://pypi.org/project/waybacktweets) [![docs](https://github.com/claromes/waybacktweets/actions/workflows/docs.yml/badge.svg)](https://github.com/claromes/waybacktweets/actions/workflows/docs.yml) [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://waybacktweets.streamlit.app)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.12528448.svg)](https://doi.org/10.5281/zenodo.12528448) [![PyPI](https://img.shields.io/pypi/v/waybacktweets)](https://pypi.org/project/waybacktweets) [![docs](https://github.com/claromes/waybacktweets/actions/workflows/docs.yml/badge.svg)](https://github.com/claromes/waybacktweets/actions/workflows/docs.yml) [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://waybacktweets.streamlit.app)

Retrieves archived tweets CDX data from the Wayback Machine, performs necessary parsing (see [Field Options](https://claromes.github.io/waybacktweets/field_options.html)), and saves the data in HTML (for easy viewing of the tweets using the `iframe` tag), CSV, and JSON formats.

Expand Down
3 changes: 3 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Pre-release: |release|

Retrieves archived tweets CDX data from the Wayback Machine, performs necessary parsing (see :ref:`field_options`), and saves the data in HTML (for easy viewing of the tweets using the ``iframe`` tag), CSV, and JSON formats.

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.12528448.svg
:target: https://doi.org/10.5281/zenodo.12528448

.. note::
Intensive queries can lead to rate limiting, resulting in a temporary ban of a few minutes from web.archive.org.

Expand Down

0 comments on commit 4aabc2a

Please sign in to comment.