carbon-tools

A set of CO2 footprint tools to measure the impact of the code we ship

https://github.com/dvelasquez/carbon-tools

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.9%) to scientific vocabulary

Keywords from Contributors

plagiarism-checker snapshot-testing serializer genomics yolov5 e2e-testing data-structures embedded graph-generation optim
Last synced: 10 months ago · JSON representation

Repository

A set of CO2 footprint tools to measure the impact of the code we ship

Basic Info
  • Host: GitHub
  • Owner: dvelasquez
  • License: mit
  • Language: TypeScript
  • Default Branch: main
  • Size: 5.44 MB
Statistics
  • Stars: 16
  • Watchers: 2
  • Forks: 1
  • Open Issues: 5
  • Releases: 0
Created almost 6 years ago · Last pushed 11 months ago
Metadata Files
Readme License

README.md

Carbon Tools

lerna

This is a mono-repository/multi-package built with Lerna & TypeScript.

Contents

  1. bytes-to-co2: A library that estimates the CO2 released to the atmosphere based on the transferred byte size.
  2. co2-extension: A Chrome (for now) that shows the amount of CO2 released by visiting the current page.
  3. lighthouse-plugin-co2: A Lighthouse Plugin that calculates the CO2 of all the data transferred by a page.
  4. co2-data: A small library with information of carbon intensities by country.

Using as a dependency

For now, we are only exposing as libraries co2-data and bytes-to-co2, which you can install in your project using:

  • yarn add bytes-to-co2 or npm i bytes-to-co2
  • yarn add co2-data or npm i co2-data

Development - Getting started

Project supports NodeJS >= v20.x

  1. Clone the project git clone https://github.com/dvelasquez/carbon-tools.git
  2. Run pnpm i to install the dev dependencies
  3. Use pnpm lerna:build to build all the libraries
  4. Use pnpm lint to lint files and catch issues with the code styling, or possible code errors
  5. Use pnpm test to run Node TAP tests

Owner

  • Name: Danilo Velasquez Urrutia
  • Login: dvelasquez
  • Kind: user
  • Location: Spain
  • Company: Adevinta

Hello there!

GitHub Events

Total
  • Issues event: 1
  • Watch event: 2
  • Delete event: 136
  • Issue comment event: 13
  • Push event: 570
  • Pull request event: 251
  • Create event: 122
Last Year
  • Issues event: 1
  • Watch event: 2
  • Delete event: 136
  • Issue comment event: 13
  • Push event: 570
  • Pull request event: 251
  • Create event: 122

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 547
  • Total Committers: 7
  • Avg Commits per committer: 78.143
  • Development Distribution Score (DDS): 0.614
Past Year
  • Commits: 192
  • Committers: 3
  • Avg Commits per committer: 64.0
  • Development Distribution Score (DDS): 0.516
Top Committers
Name Email Commits
dependabot[bot] 4****] 211
Danilo Velasquez d****z@g****m 173
renovate[bot] 2****] 93
Danilo Velasquez d****z@a****m 25
dependabot-preview[bot] 2****] 24
Danilo Velasquez n****l 20
Danilo Velasquez d****z@p****n 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 2
  • Total pull requests: 571
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 17 days
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.47
  • Merged pull requests: 338
  • Bot issues: 2
  • Bot pull requests: 570
Past Year
  • Issues: 2
  • Pull requests: 276
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 5 days
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.05
  • Merged pull requests: 221
  • Bot issues: 2
  • Bot pull requests: 276
Top Authors
Issue Authors
  • dependabot[bot] (1)
  • renovate[bot] (1)
Pull Request Authors
  • dependabot[bot] (317)
  • renovate[bot] (253)
  • dvelasquez (1)
Top Labels
Issue Labels
dependencies (1)
Pull Request Labels
dependencies (317)

Packages

  • Total packages: 1
  • Total downloads:
    • npm 996 last-month
  • Total dependent packages: 2
  • Total dependent repositories: 2
  • Total versions: 173
  • Total maintainers: 1
npmjs.org: bytes-to-co2

Javascript module that calculates the co2 generated in transfer x amount of bytes over the network and the country.

  • License: MIT
  • Latest release: 0.3.169
    published 10 months ago
  • Versions: 173
  • Dependent Packages: 2
  • Dependent Repositories: 2
  • Downloads: 996 Last month
Rankings
Dependent repos count: 7.6%
Stargazers count: 8.6%
Dependent packages count: 8.8%
Average: 11.1%
Forks count: 11.6%
Downloads: 18.9%
Maintainers (1)
Last synced: 10 months ago

Dependencies

package.json npm
  • @rollup/plugin-commonjs ^22.0.0 development
  • @types/eslint ^8.2.1 development
  • @types/prettier ^2.1.1 development
  • @types/tap ^15.0.1 development
  • @typescript-eslint/eslint-plugin ^4.5.0 development
  • @typescript-eslint/parser ^4.5.0 development
  • cpy-cli ^4.1.0 development
  • cross-env ^7.0.2 development
  • eslint ^7.12.0 development
  • eslint-config-prettier ^8.3.0 development
  • eslint-plugin-prettier ^4.0.0 development
  • lerna ^4.0.0 development
  • prettier ^2.1.2 development
  • rimraf ^3.0.2 development
  • rollup ^2.32.1 development
  • rollup-plugin-typescript2 ^0.32.0 development
  • tap ^16.0.1 development
  • ts-node ^9.0.0 development
  • typescript ^4.0.3 development
packages/bytes-to-co2/package.json npm
  • co2-data ^0.0.27
packages/lighthouse-plugin-co2/package.json npm
  • lighthouse ^9.2.0 development
  • bytes-to-co2 ^0.3.29
yarn.lock npm
  • 969 dependencies
.github/workflows/lerna_push_pr.yml actions
  • actions/checkout v2 composite
  • actions/setup-node v2-beta composite
.github/workflows/release-canary.yml actions
  • actions/checkout v2 composite
  • actions/setup-node v2-beta composite
.github/workflows/release.yml actions
  • actions/checkout v2 composite
  • actions/setup-node v2-beta composite