node-genderize's Introduction

genderize

Install with npm install genderize. This is a wrapper for the genderize web service.

Note that you should not use this to guess which gender you should assign to a person. Names are not a reliable predictor of which gender people want to use. I think it should only be used for analytical purposes of a set of names.

Example

var genderize = require('genderize')

genderize('Julia', function (err, obj) {
  console.log(obj.gender) // outputs 'female'
})

// optional localization parameters (see https://genderize.io/#localization)
genderize('Andrea', {language_id: 'it'}, function (err, obj) {
  console.log(obj.gender) // outputs 'male'
})

Stream

objectStream
  .pipe(genderize({language_id: 'it'}))
  .pipe(ndjson.stringify())
  .pipe(process.out)

List

genderize.list(['Julia', 'Finn', 'Christian', 'Andrea'], function (err, obj) {
  console.log(obj)
})

genderize.list(['Julia', 'Finn', 'Christian', 'Andrea'], {language_id: 'it'}, function (err, obj) {
  console.log(obj)
})

CLI

You can also do npm install genderize -g and you will get a simple streaming interface for piping in names and getting beck new line delimited JSON objects.

Given names.txt

"Julia"
Florian
Finn
Andrea

This command could result. Note that it doesn't have to be in the correct order.

$ genderize < names.txt
{"name":"Julia","gender":"female","probability":"0.99","count":2099}
{"name":"Florian","gender":"male","probability":"1.00","count":469}
{"name":"Finn","gender":"male","probability":"0.99","count":81}
{"name":"Andrea","gender":"female","probability":"0.79","count":5623}

$ genderize --language_id it < names.txt
{"name":"Julia","gender":"female","probability":"1.00","count":7,"language_id":"it"}
{"name":"Florian","gender":"male","probability":"1.00","count":4,"language_id":"it"}
{"name":"Finn","gender":null,"language_id":"it"}
{"name":"Andrea","gender":"male","probability":"0.98","count":1033,"language_id":"it"}

node-genderize's People

Contributors

Stargazers

Watchers

node-genderize's Issues

[QUESTION] Is project maintained?

I come across the public API genderize from toddmotto/public-apis and would like to know if this repo still being maintaining since the last update was 5 months ago. It'd be nice if I can help out in contribution 😄 .

iterate through a list of text files in CLI?

Hello Finn and other members of this Team:

thank you very much for sharing your helpful wrapper.

i like it a lot and have no issue. so i hope i can still post my question here... which is how i may iterate the .stream method of this wrapper through a set of text files of names? as in, to run this line

"genderize --country_id=de < .../orig/de.txt > .../output/de.txt"

for 220 input files created for different countries, may i create a loop in the terminal where only the string "de" changes in each iteration?

i have created these files to be able to run the code with the "country_id" parameter. now i hope to learn to automate the process of feeding in these files, but i do not have a structure in my mind about how. i wonder if any of you would mind giving some direction on trying this?

Viele Grüße
Jinzhao