@artginzburg/github-user-downloads - npm Package Compare versions

Comparing version 0.3.0 to 0.4.0

package.json

 {
   "name": "@artginzburg/github-user-downloads",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Get total downloads of all repos by username",
@@ -13,10 +13,7 @@ "license": "ISC",
   },
-  "main": "endpoint.js",
   "scripts": {
-    "start": "node test",
-    "test": "node app"
+    "start": "node test"
   },
   "dependencies": {
-    "@octokit/rest": "^18.12.0",
-    "express": "^4.17.1"
+    "@octokit/rest": "^18.12.0"
   },
@@ -23,0 +20,0 @@ "devDependencies": {

README.md

@@ -1,17 +0,27 @@
-# Custom GitHub user total downloads badge for everyone!
+# Purpose
 
-Use the following URL and change `:user` at the end to the username of a GitHub user
+Getting total number of downloads
+for all releases
+of all repositories
+of a GitHub user
+by username
 
-```
-https://img.shields.io/endpoint?url=https://artginzburg.runkit.io/github-user-downloads/branches/master/:user
-```
+## Limitations
 
-## Example
+This is for testing and personal purposes only (for now)
 
-Using Markdown syntax:
-`![](https://img.shields.io/endpoint?url=https://artginzburg.runkit.io/github-user-downloads/branches/master/artginzburg)`
+> I'm planning to build sort of an ecosystem around it later
 
-Outputs this:
-<sub>![](https://img.shields.io/endpoint?url=https://artginzburg.runkit.io/github-user-downloads/branches/master/artginzburg)</sub>
+# Preparation
 
-> You can still style the badge however you want as documented at https://shields.io/#styles
+> Assuming you have Node.JS installed
+
+1. Create a Personal Access Token (Following [GitHub Docs](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token))
+   > No scopes (permissions) needed — just the token
+
+# Testing
+
+1. Clone the repo
+2. Install dependencies (`npm i`)
+3. Set `PERSONAL_ACCESS_TOKEN` and `USER` environmental variables (use `.env` file if you want)
+4. Run `npm start`

test.js

@@ -1,2 +0,2 @@
-const getUserDownloads = require('./index');
+const getUserDownloads = require('./');
 
@@ -3,0 +3,0 @@ require('dotenv').config();

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Dependency count

1

decreased by-50%

Number of lines in readme file

28

increased by55.56%

Number of low supply chain risk alerts

2

decreased by-33.33%

Worsened metrics

Total package byte prevSize

2707

decreased by-23.81%

Number of package files

5

decreased by-28.57%

Lines of code

42

decreased by-40%

Dependency changes

• - Removedexpress@^4.17.1

• - Removedaccepts@1.3.8(transitive)

• - Removedarray-flatten@1.1.1(transitive)

• - Removedbody-parser@1.20.3(transitive)

• - Removedbytes@3.1.2(transitive)

• - Removedcall-bind@1.0.7(transitive)

• - Removedcontent-disposition@0.5.4(transitive)

• - Removedcontent-type@1.0.5(transitive)

• - Removedcookie@0.7.1(transitive)

• - Removedcookie-signature@1.0.6(transitive)

• - Removeddebug@2.6.9(transitive)

• - Removeddefine-data-property@1.1.4(transitive)

• - Removeddepd@2.0.0(transitive)

• - Removeddestroy@1.2.0(transitive)

• - Removedee-first@1.1.1(transitive)

• - Removedencodeurl@1.0.22.0.0(transitive)

• - Removedes-define-property@1.0.0(transitive)

• - Removedes-errors@1.3.0(transitive)

• - Removedescape-html@1.0.3(transitive)

• - Removedetag@1.8.1(transitive)

• - Removedexpress@4.21.1(transitive)

• - Removedfinalhandler@1.3.1(transitive)

• - Removedforwarded@0.2.0(transitive)

• - Removedfresh@0.5.2(transitive)

• - Removedfunction-bind@1.1.2(transitive)

• - Removedget-intrinsic@1.2.4(transitive)

• - Removedgopd@1.0.1(transitive)

• - Removedhas-property-descriptors@1.0.2(transitive)

• - Removedhas-proto@1.0.3(transitive)

• - Removedhas-symbols@1.0.3(transitive)

• - Removedhasown@2.0.2(transitive)

• - Removedhttp-errors@2.0.0(transitive)

• - Removediconv-lite@0.4.24(transitive)

• - Removedinherits@2.0.4(transitive)

• - Removedipaddr.js@1.9.1(transitive)

• - Removedmedia-typer@0.3.0(transitive)

• - Removedmerge-descriptors@1.0.3(transitive)

• - Removedmethods@1.1.2(transitive)

• - Removedmime@1.6.0(transitive)

• - Removedmime-db@1.52.0(transitive)

• - Removedmime-types@2.1.35(transitive)

• - Removedms@2.0.02.1.3(transitive)

• - Removednegotiator@0.6.3(transitive)

• - Removedobject-inspect@1.13.3(transitive)

• - Removedon-finished@2.4.1(transitive)

• - Removedparseurl@1.3.3(transitive)

• - Removedpath-to-regexp@0.1.10(transitive)

• - Removedproxy-addr@2.0.7(transitive)

• - Removedqs@6.13.0(transitive)

• - Removedrange-parser@1.2.1(transitive)

• - Removedraw-body@2.5.2(transitive)

• - Removedsafe-buffer@5.2.1(transitive)

• - Removedsafer-buffer@2.1.2(transitive)

• - Removedsend@0.19.0(transitive)

• - Removedserve-static@1.16.2(transitive)

• - Removedset-function-length@1.2.2(transitive)

• - Removedsetprototypeof@1.2.0(transitive)

• - Removedside-channel@1.0.6(transitive)

• - Removedstatuses@2.0.1(transitive)

• - Removedtoidentifier@1.0.1(transitive)

• - Removedtype-is@1.6.18(transitive)

• - Removedunpipe@1.0.0(transitive)

• - Removedutils-merge@1.0.1(transitive)

• - Removedvary@1.1.2(transitive)