{"analyzedAt":"2022-07-09T21:07:22.323Z","collected":{"metadata":{"name":"geolite2","scope":"unscoped","version":"3.5.1","description":"Maxmind's GeoLite2 Free Databases","keywords":["maxmind","mmdb","geo","geoip","geoip2","geobase","geo lookup"],"date":"2022-04-05T11:57:09.727Z","author":{"name":"Dmitry Shirokov","email":"deadrunk@gmail.com","username":"runk"},"publisher":{"username":"runk","email":"deadrunk@gmail.com"},"maintainers":[{"username":"runk","email":"deadrunk@gmail.com"}],"repository":{"type":"git","url":"git+https://github.com/runk/node-geolite2.git"},"links":{"npm":"https://www.npmjs.com/package/geolite2","homepage":"https://github.com/runk/node-geolite2#readme","repository":"https://github.com/runk/node-geolite2","bugs":"https://github.com/runk/node-geolite2/issues"},"license":"MIT","dependencies":{"tar":"^5.0.5"},"devDependencies":{"mocha":"^5.2.0","prettier":"^2.6.0","semantic-release":"^17.0.8"},"releases":[{"from":"2022-06-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":1},{"from":"2022-04-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":1},{"from":"2022-01-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":3},{"from":"2021-07-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":3},{"from":"2020-07-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":6}],"hasTestScript":true,"readme":"# node-geolite2\n\nMaxmind's GeoLite2 Free Databases download helper.\n\n## Configuration\n\n### Access Key\n\n**IMPORTANT** You must setup `MAXMIND_LICENSE_KEY` environment variable be able to download databases. To do so, go to the https://www.maxmind.com/en/geolite2/signup, create a free account and generate new license key.\n\nIf you don't have access to the environment variables during installation, you can provide license key via `package.json`:\n\n```jsonc\n{\n  ...\n  \"geolite2\": {\n    // specify the key\n    \"license-key\": \"<your license key>\",\n    // ... or specify the file where key is located:\n    \"license-file\": \"maxmind-license.key\"\n  }\n  ...\n}\n```\n\nBeware of security risks of adding keys and secrets to your repository!\n\n### Selecting databases to download\n\nYou can select the dbs you want downloaded by adding a `selected-dbs` property on `geolite2` via `package.json`.\n\n`selected-dbs` must be an array of strings, one or more of the values `City`, `Country`, `ASN`.\n\nIf `selected-dbs` is unset, or is set but empty, all dbs will be downloaded.\n\n```jsonc\n{\n  ...\n  \"geolite2\": {\n    \"selected-dbs\": [\"City\", \"Country\", \"ASN\"]\n  }\n  ...\n}\n```\n\n## Usage\n\n```javascript\nvar geolite2 = require('geolite2');\nvar maxmind = require('maxmind');\n\nvar lookup = maxmind.openSync(geolite2.paths.city); // or geolite2.paths.country or geolite2.paths.asn\nvar city = lookup.get('66.6.44.4');\n```\n\n## Alternatives\n\n[geolite2-redist](https://github.com/GitSquared/node-geolite2-redist) provides redistribution which does not require personal license key. Make sure you understand legal terms and what they mean for your use-case.\n\n## License\n\nCreative Commons Attribution-ShareAlike 4.0 International License"},"npm":{"downloads":[{"from":"2022-07-08T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":1829},{"from":"2022-07-02T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":8009},{"from":"2022-06-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":37543},{"from":"2022-04-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":120498},{"from":"2022-01-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":216821},{"from":"2021-07-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":393492}],"starsCount":0},"github":{"starsCount":53,"forksCount":15,"subscribersCount":3,"issues":{"count":42,"openCount":0,"distribution":{"3600":18,"10800":3,"32400":3,"97200":2,"291600":1,"874800":6,"2624400":4,"7873200":2,"23619600":2,"70858800":1,"212576400":0},"isDisabled":false},"contributors":[{"username":"baleevskiy","commitsCount":7},{"username":"ALMaclaine","commitsCount":1},{"username":"neilstuartcraig","commitsCount":1},{"username":"sbma44","commitsCount":1},{"username":"runk","commitsCount":45},{"username":"GitSquared","commitsCount":3}],"commits":[{"from":"2022-07-02T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":0},{"from":"2022-06-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":0},{"from":"2022-04-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":0},{"from":"2022-01-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":5},{"from":"2021-07-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":5}]},"source":{"files":{"readmeSize":1701,"testsSize":634},"linters":["prettier"],"outdatedDependencies":{"tar":{"required":"^5.0.5","stable":"6.1.11","latest":"6.1.11"}}}},"evaluation":{"quality":{"carefulness":0.84,"tests":0.6,"health":0.75,"branding":0},"popularity":{"communityInterest":77,"downloadsCount":40166,"downloadsAcceleration":74.96847412480975,"dependentsCount":0},"maintenance":{"releasesFrequency":0.9117294520547945,"commitsFrequency":0.9,"openIssues":1,"issuesDistribution":0.9}},"score":{"final":0.6465888405888809,"detail":{"quality":0.8178754546707278,"popularity":0.14644004935187155,"maintenance":0.9999205340414501}}}