co2.js

An npm module for accessing the green web API, and estimating the carbon emissions from using digital services

https://github.com/thegreenwebfoundation/co2.js

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 (14.0%) to scientific vocabulary

Keywords

carbon-estimates co2 co2-emissions hacktoberfest non-profit open-source sustainability

Keywords from Contributors

climate snapshot-testing climate-models state-management actions batteries particles genomics interactive projection

Last synced: 6 months ago · JSON representation

Repository

An npm module for accessing the green web API, and estimating the carbon emissions from using digital services

Basic Info

Host: GitHub
Owner: thegreenwebfoundation
License: other
Language: JavaScript
Default Branch: main
Homepage: https://developers.thegreenwebfoundation.org/
Size: 7.63 MB

Statistics

Stars: 465
Watchers: 15
Forks: 63
Open Issues: 28
Releases: 43

Topics

carbon-estimates co2 co2-emissions hacktoberfest non-profit open-source sustainability

Created almost 6 years ago · Last pushed 7 months ago

Metadata Files

Readme Changelog Contributing Funding License

CO2.js

One day, the internet will be powered by renewable energy. Until that day comes, there’ll be a CO2 cost that comes with every byte of data that’s uploaded or downloaded. By being able to calculate these emissions, developers can be empowered to create more efficient, lower carbon apps, websites, and software.

Documentation | Changelog | Roadmap

What is CO2.js?

CO2.js is a JavaScript library that enables developers a way to estimate the emissions related to use of their apps, websites, and software.

Why use it?

Being able to estimate the CO2 emissions associated with digital activities can be of benefit to both developers and users.

Internally, you may want to use this library to create a carbon budget for your site or app. It is also useful for inclusion in dashboards and monitoring tools.

For user facing applications, CO2.js could be used to check & block the uploading of carbon intensive files. Or, to present users with information about the carbon impact of their online activities (such as browsing a website).

The above are just a few examples of the many and varied ways CO2.js can be applied to provide carbon estimates for data transfer. If you’re using CO2.js in production we’d love to hear how! Contact us via our website.

Installation

Using NPM

You can install CO2.js as a dependency for your projects using NPM.

bash npm install @tgwf/co2

Using esm.sh

You can import the CO2.js library into projects using esm.sh.

js import tgwf from "https://esm.sh/@tgwf/co2@latest";

Using a JS CDN

You can get the latest version of CO2.js using one of the content delivery networks below.

jsDelivr

You can find the package at https://www.jsdelivr.com/package/npm/@tgwf/co2.

CommonJS compatible build https://cdn.jsdelivr.net/npm/@tgwf/co2@latest/dist/cjs/index-node.min.js
ES Modules compatible build https://cdn.jsdelivr.net/npm/@tgwf/co2@latest/dist/esm/index.js
IIFE compatible build https://cdn.jsdelivr.net/npm/@tgwf/co2@latest/dist/iife/index.js

Unpkgd

You can find the package at https://unpkg.com/browse/@tgwf/co2@latest/.

CommonJS compatible build https://unpkg.com/@tgwf/co2@latest/dist/cjs/index-node.min.js
ES Modules compatible build https://unpkg.com/@tgwf/co2@latest/dist/esm/index.js
IIFE compatible build https://unpkg.com/@tgwf/co2@latest/dist/iife/index.js

Build it yourself

You can also build the CO2.js library from the source code. To do this:

Go to the CO2.js repository on GitHub.
Clone or fork the repository.
Navigate to the folder on your machine and run npm run build in your terminal.
Once the build has finished running, you will find a /dist folder has been created. Inside you can find:

dist/cjs - A CommonJS compatible build.
dist/esm - An ES Modules compatible build.
dist/iife - An Immediately Invoked Function Expression (IIFE) version of the library.

TypeScript support

Type definitions for CO2.js are published in the DefinitelyTyped project, and are available on NPM at @types/tgwf__co2.

If you want to use type definitions in your project, they should be installed as a devDependency.

npm install --dev @types/tgwf__co2

Marginal and average emissions intensity data

CO2.js includes yearly average grid intensity data from Ember, as well as marginal intensity data from the UNFCCC (United Nations Framework Convention on Climate Change). You can find the data in JSON and CommonJS Module format in the data/output folder.

Using emissions intensity data

You can import annual, country-level marginal or average grid intensity data into your projects directly from CO2.js. For example, if we wanted to use the average grid intensity for Australia in our project, we could use the code below:

js import { averageIntensity } from "@tgwf/co2"; const { data } = averageIntensity; const { AUS } = data; console.log({ AUS });

All countries are represented by their respective Alpha-3 ISO country code.

Publishing to NPM

We use np to publish new versions of this library to NPM. To do this:

First login to NPM by running the npm login command in your terminal.
Then run npx np <VERSION>.
np will run several automated steps to publish the new package to NPM.
If everything runs successfully, you can then add release notes to GitHub for the newly published package.

Release communication

CO2.js releases will be communicated through the following channels:

| Channel | Minor Release (0.xx) | Patch Release (0.xx.x) | | ----------------------------------------------------------------------------------------------- | -------------------- | ---------------------- | | Github | ✅ | ✅ | | Green Web Foundation website | ✅ | ❌ | | W3C Slack Sustainability Channel | ✅ | ❌ | | ClimateAction.Tech Slack | ✅ | ❌ | | Green Web Foundation LinkedIn Account | ✅ | ❌ |

Licenses

The code for CO2.js is licensed Apache 2.0. (What does this mean?)

The average carbon intensity data from Ember is published under the Creative Commons ShareAlike Attribution Licence (CC BY-SA 4.0). (What does this mean?)

The marginal intensity data is published by the Green Web Foundation, under the Creative Commons ShareAlike Attribution Licence (CC BY-SA 4.0). (What does this mean?)

See LICENCE for more.

Contributors

To contribute changes back to this project, please follow the steps outlined in the CONTRIBUTING.md file in this repository.

_{Chris Adams} 💻	_fershad 💻 📖 🚧	_{Peter Hedenskog} 💻	_Dryden 💻	_{Evan Hahn} 💻 ⚠️	_{Prathum Pandey} 🐛 💻	_{Frazer Smith} 💻 ⚠️
_{Hamish Fagg} 💻	_{Atul Varma} 💻	_Piper 💻	_{Raymundo Vásquez Ruiz} 💻	_JamieB 💻	_p-gerard 🐛 💻	_{Simon Fishel} 💻
_{Dani Subject} 💻	_{Malay Kumar} 📖	_{Samuel Ikoli} 📖	_{Ash Johns} 🐛 💻	_{Matthew Griffin} 📖 💻	_Hannah 📖	_Alex 💻

Owner

Name: The Green Web Foundation
Login: thegreenwebfoundation
Kind: organization
Email: dev@thegreenwebfoundation.org
Location: The Internet

Website: https://www.thegreenwebfoundation.org
Twitter: greenwebfound
Repositories: 69
Profile: https://github.com/thegreenwebfoundation

The Green Web Foundation - Let's make the web green

GitHub Events

Total

Create event: 19
Release event: 7
Issues event: 16
Watch event: 65
Delete event: 1
Issue comment event: 37
Push event: 45
Pull request review event: 2
Pull request review comment event: 2
Pull request event: 36
Fork event: 9

Last Year

Create event: 19
Release event: 7
Issues event: 16
Watch event: 65
Delete event: 1
Issue comment event: 37
Push event: 45
Pull request review event: 2
Pull request review comment event: 2
Pull request event: 36
Fork event: 9

Committers

Last synced: 7 months ago

All Time

Total Commits: 623
Total Committers: 27
Avg Commits per committer: 23.074
Development Distribution Score (DDS): 0.52

Past Year

Commits: 78
Committers: 8
Avg Commits per committer: 9.75
Development Distribution Score (DDS): 0.167

Top Committers

Name	Email	Commits
fershad	2****d	299
Chris Adams	c**s@p**k	133
Fershad	i**h@f**m	81
soulgalore	p**r@s**m	25
drydenwilliams	h**o@d**k	19
dependabot[bot]	4****]	15
Frazer Smith	f**v@o**m	8
Brett Tackaberry	b**t@r**m	7
Evan Hahn	me@e****m	5
Malay Kumar	m**3@g**m	4
Simon Fishel	s**f@g**m	3
allcontributors[bot]	4****]	3
Ash Johns	m**l@a**m	2
Matthew Griffin	m**n@s**m	2
PrathumP	1****P	2
hamishfagg	i**b@i**t	2
hanopcan	h**h@o**k	2
Alexander zur Bonsen	a**n@t**m	2
Atul Varma	v**a@g**m	1
Danielle Subject	D**t@i**m	1
JamieB	j**e@g**k	1
Pierre GERARD	p**d@c**m	1
Piper	p**r@g**m	1
Raymundo Vásquez Ruiz	r**r@p**m	1
Jesper Fogh	f**f@g**m	1
Thibaud Colas	t**s@g**m	1
samuelIkoli	a**i@g**m	1

Committer Domains (Top 20 + Academic)

contentsquare.com: 1 greengumption.co.uk: 1 ibm.com: 1 tngtech.com: 1 opcan.co.uk: 1 ivdata.net: 1 scottlogic.com: 1 ashpjohns.com: 1 evanhahn.com: 1 rebel.com: 1 drydenwilliams.co.uk: 1 soulgalore.com: 1 fershad.com: 1 productscience.co.uk: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 94
Total pull requests: 172
Average time to close issues: 4 months
Average time to close pull requests: 28 days
Total issue authors: 30
Total pull request authors: 28
Average comments per issue: 3.97
Average comments per pull request: 1.28
Merged pull requests: 141
Bot issues: 0
Bot pull requests: 63

Past Year

Issues: 14
Pull requests: 34
Average time to close issues: 20 days
Average time to close pull requests: 10 days
Issue authors: 6
Pull request authors: 8
Average comments per issue: 1.57
Average comments per pull request: 0.56
Merged pull requests: 27
Bot issues: 0
Bot pull requests: 23

View more stats

Top Authors

Issue Authors

mrchrisadams (31)
fershad (25)
soulgalore (4)
drydenwilliams (3)
michael-voit (2)
hanopcan (2)
mgriffin-scottlogic (2)
alexzurbonsen (2)
mgifford (2)
thibaudcolas (1)
wisefool (1)
samuelIkoli (1)
p-gerard (1)
mishushakov (1)
iljapanic (1)

Pull Request Authors

github-actions[bot] (39)
fershad (37)
dependabot[bot] (31)
mrchrisadams (28)
soulgalore (15)
sfishel18 (6)
Fdawgs (6)
drydenwilliams (5)
alexzurbonsen (4)
samuelIkoli (2)
EvanHahn (2)
allcontributors[bot] (2)
SekhReddy (2)
dsubject (2)
thibaudcolas (2)

Top Labels

Issue Labels

enhancement (9) good first issue (8) help wanted (8) roadmap (7) data (3) hacktoberfest (3) documentation (3) internal facing (1) confirmed (1) release-planned (1) gwf-green-code-challenge (1) funding-required (1)

Pull Request Labels

dependencies (31) javascript (4) help wanted (1)

Packages

Total packages: 2
Total downloads:
- npm 27,816 last-month
Total docker downloads: 36,880,715

Total dependent packages: 6
(may contain duplicates)
Total dependent repositories: 25
(may contain duplicates)
Total versions: 69
Total maintainers: 4

npmjs.org: @tgwf/co2

Work out the co2 of your digital services

Homepage: https://github.com/thegreenwebfoundation/co2.js#readme
License: Apache-2.0
Latest release: 0.16.8
published 9 months ago

Versions: 62
Dependent Packages: 6
Dependent Repositories: 25
Downloads: 27,814 Last month
Docker Downloads: 36,880,715

Rankings

Docker downloads count: 0.2%

Downloads: 1.1%

Dependent repos count: 2.6%

Average: 2.8%

Stargazers count: 3.8%

Dependent packages count: 4.4%

Forks count: 4.6%

Maintainers (3)

fershad mrchrisadams franka

Last synced: 6 months ago

npmjs.org: @makakwastaken/co2

Work out the co2 of your digital services

Homepage: https://github.com/thegreenwebfoundation/co2.js#readme
License: Apache-2.0
Latest release: 0.12.4
published over 2 years ago

Versions: 7
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 2 Last month

Rankings

Stargazers count: 3.9%

Forks count: 4.6%

Downloads: 10.4%

Average: 12.9%

Dependent repos count: 18.8%

Dependent packages count: 27.0%

Maintainers (1)

makakwastaken

Last synced: 6 months ago

Dependencies

package-lock.json npm

636 dependencies

package.json npm

@tgwf/url2green ^0.4.0 development
eslint ^8.15.0 development
eslint-config-prettier ^8.5.0 development
eslint-plugin-jest ^26.1.5 development
eslint-plugin-prettier ^4.0.0 development
jest ^28.1.0 development
nock ^13.2.4 development
np ^7.6.1 development
pagexray ^4.4.2 development
prettier ^2.6.2 development
debug ^4.3.4

.github/workflows/unittests.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/update-average-intensities.yml actions

actions/checkout v3 composite
peter-evans/create-pull-request v5 composite

co2.js

Science Score: 26.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

CO2.js

Documentation | Changelog | Roadmap

What is CO2.js?

Why use it?

Installation

Using NPM

Using esm.sh

Using a JS CDN

jsDelivr

Unpkgd

Build it yourself

TypeScript support

Marginal and average emissions intensity data

Using emissions intensity data

Publishing to NPM

Release communication

Licenses

Contributors

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @tgwf/co2

Rankings

Maintainers (3)

npmjs.org: @makakwastaken/co2

Rankings

Maintainers (1)

Dependencies