This small library wraps up the data collected by Transparency International in their Corruption Perception Index. The data is available in CSV/Excel format on their website. This library provides a simple interface to the data. The original data is licensed under the Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0) license. The data converted from Excel to CSV is hosted in this directory in the file CPI2023_GlobalResultsTrends.csv and is licensed under the same license. The code itself is licensed under the MIT License.
You can install this library using NPM:
npm i --save ti-cpi
Then you can use it in your (TypeScript) code like this:
import {tiCpi, tiCpiForYear, tiCpiUrl} from "ti-cpi";
import {testPathPatternToRegExp} from "jest-util";
const iso2CountryCode = "AT";
// Fetch all the data for a specific country
const austria = tiCpi({iso2CountryCode})
const austria2020 = tiCpiForYear({iso2CountryCode}, 2020);
// Fetch the URL of a countries CPI page
const url = tiCpiUrl({iso2CountryCode});
Transparency international releases the update data annually in January. We are on relevant news-letters and update this library as soon as possible after receiving the update information.
To build this library you can run:
npm run build
A version published to NPM can be created by following the following checklist:
- Bump the version in
package.json
- Run
npm run build
locally to verify the build is working - Run
npm run test
locally to verify none of the tests are failing - Commit and pus the changes to the main branch
- Create a new release on GitHub with the version number as the tag
- The CI configuration in
.github/workflows/release.yml
will automatically publish the new version to NPM