{"id":16703784,"url":"https://github.com/leeper/lumendb","last_synced_at":"2025-04-10T05:05:30.681Z","repository":{"id":70769746,"uuid":"45603154","full_name":"leeper/lumendb","owner":"leeper","description":"Lumen Database (Chilling Effects) API Client","archived":false,"fork":false,"pushed_at":"2017-10-10T12:32:20.000Z","size":20,"stargazers_count":14,"open_issues_count":2,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-24T06:12:01.875Z","etag":null,"topics":["chilling-effects","copyright","copyright-takedown","cran","lumen-database","r"],"latest_commit_sha":null,"homepage":"https://cloud.r-project.org/package=lumendb","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leeper.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-11-05T10:06:39.000Z","updated_at":"2024-12-30T12:25:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"69ab0bbc-a70c-4471-9b8a-03b23b91acb7","html_url":"https://github.com/leeper/lumendb","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leeper%2Flumendb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leeper%2Flumendb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leeper%2Flumendb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leeper%2Flumendb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leeper","download_url":"https://codeload.github.com/leeper/lumendb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248161280,"owners_count":21057554,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chilling-effects","copyright","copyright-takedown","cran","lumen-database","r"],"created_at":"2024-10-12T19:09:34.099Z","updated_at":"2025-04-10T05:05:30.673Z","avatar_url":"https://github.com/leeper.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lumen Database API Client\n\n**lumendb** is a simple client package for the [Lumen Database](http://lumendatabase.org/) (formerly Chilling Effects) [API](https://github.com/berkmancenter/lumendatabase/blob/master/doc/api_documentation.mkd). It can retrieve, as well as deposit, copyright takedown notices from the Lumen database. It may be useful for tracking who is sending copyright-related cease and desist orders and what material is being used in apparent violation of copyright.\n\nAll Lumen Database data [is released under to Public Domain (CC0)](https://www.lumendatabase.org/pages/license), though the API has additional [terms of use](https://lumendatabase.org/pages/api_terms).\n\nUse of the package does not require an API token, though Lumen rate limits non-authenticated requests. To request a token, contact Lumen directly at: team (at) lumendatabase.org. The token should then be stored as an environment variable:\n\n```R\nSys.setenv(LUMEN_TOKEN = \"t1o2k3e4n5v6a7l8u9e\")\n```\n\nOr this can be passed atomically to every API call. Setting the environment variable is simpler and more secure because it will not be recorded in R history logs.\n\n## Code Examples\n\n\nThe key functionality of the package is to retrieve notices by their identification numbers and to search for notices. To retrieve a single notice, just query it:\n\n```{r}\nlibrary(\"lumendb\")\nx \u003c- ldnotice(1)\nsummary(x)\n```\n\nThe `summary()` method will print some essential details for each notice, as seen above.\n\nThe other major function is to search for notices by keyword. The search functionality is pretty complicated, so I have not written R-specific documentation for it. The search API is based on elastic search and [Lumen's documentation is available on GitHub](https://github.com/berkmancenter/lumendatabase/blob/dev/doc/api_documentation.mkd#search-notices-via-fulltext) for those who are interested. As a simple example, one can perform a full-text search for notices related to YouTube:\n\n```{r}\nx \u003c- ldsearch(list(term = \"youtube\"))\nprint(x)\n```\n\nAnother example would be to retrieve 100 requests from a major takedown requester, The Publishers Association, which represents a large number of publishing companies:\n\n```{r}\n# query 50 notices\nx \u003c- ldsearch(list(sender_name = \"The Publishers Association\"), per_page = 50)\n\n# view first two notices\nsummary(x[[1]])\nsummary(x[[2]])\n```\n\nThe `ldsearch()` function is, like the API it wraps, paginated and pagination details are printed by to the console by default and are available in `meta` attribute in the search result list.\n\nNote: the notice submission API is not yet implemented in this package.\n\n## Installation\n\n[![CRAN](https://www.r-pkg.org/badges/version/lumendb)](https://cran.r-project.org/package=lumendb)\n![Downloads](https://cranlogs.r-pkg.org/badges/lumendb)\n[![Build Status](https://travis-ci.org/leeper/lumendb.png?branch=master)](https://travis-ci.org/leeper/lumendb) \n[![codecov.io](https://codecov.io/github/leeper/lumendb/coverage.svg?branch=master)](https://codecov.io/github/leeper/lumendb?branch=master)\n\nThis package is not yet on CRAN. To install the latest development version from GitHub, run the following:\n\n```R\nif (!require(\"ghit\")) {\n    install.packages(\"ghit\")\n}\nghit::install_github(\"leeper/lumendb\")\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleeper%2Flumendb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleeper%2Flumendb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleeper%2Flumendb/lists"}