steelpangolin / genderize

Python client for the Genderize.io web service.

Genderize

Client for the Genderize.io web service.

Basic usage

Import the Genderize class and call its get method with a list of names.

from genderize import Genderize
print(Genderize().get(['James', 'Eva', 'Thunderhorse']))

[{u'count': 1037, u'gender': u'male', u'name': u'James', u'probability': 0.99},
 {u'count': 234, u'gender': u'female', u'name': u'Eva', u'probability': 1.0},
 {u'gender': None, u'name': u'Thunderhorse'}]

Shell usage

If run as a script, takes a list of names on stdin, and prints them with their genders.

echo "James\nEva\nThunderhorse" | python -m genderize

James: male
Eva: female
Thunderhorse: None

Advanced usage

Create a Genderize instance with a custom user agent, an API key, and a shorter timeout than the default 30 seconds. Note that you'll need to use your own API key or this example won't work.

from genderize import Genderize
genderize = Genderize(
    user_agent='GenderizeDocs/0.0',
    api_key='example_api_key',
    timeout=5.0)
print(genderize.get(['James', 'Eva', 'Thunderhorse']))

[{u'count': 1037, u'gender': u'male', u'name': u'James', u'probability': 0.99},
 {u'count': 234, u'gender': u'female', u'name': u'Eva', u'probability': 1.0},
 {u'gender': None, u'name': u'Thunderhorse'}]

Maintenance

Setup for local development:

virtualenv --prompt '(genderize) ' venv -p python3
pip install -r requirements.txt
pip install -r requirements-dev.txt

Release checklist:

1. Generate a new version number: major.minor.micro. It should be compatible with both PEP 440 and SemVer 2.0.0.
2. Update __version__ in genderize/__init__.py. This is read by setup.py and doesn't need to be changed there.
3. Add a changelog entry and date for the new version in CHANGES.rst.
4. Commit the changes. This may be done as part of another change.
5. Tag the commit with git tag major.minor.micro.
6. Push the tag to GitHub with git push origin major.minor.micro.
7. Travis will create a new PyPI release from the tag.

genderize's Issues

using genderiz with big datasets

I am trying to use the genderize library to find the gender of a database of 7 thousands name, however, the function only returns the gender of the 10 first names in the dataset. Here is my code:
from genderize import Genderize
import csv
with open('mydata.csv', 'rb') as f:
reader = csv.reader(f)
your_list = list(reader)
print(Genderize().get(your_list))

It used to work but now I get “SSL: CERTIFICATE_VERIFY_FAILED” Error

I use it ~700 times a day with 1 name each time.
What can I do to solve it ?

Process stuck on windows

    logger.info("Start the genderize api")
    gen = (Genderize().get(names=[name_lowercase]))
    logger.info("end the genderize api")

The first line is set but we don't reach the second one, ctrl+c don't even close the process!
Is it that something is stuck ?

Give an option to not only return the data, but also the header

There are important informations regarding rate limit in the response header stated here.

X-Rate-Limit-Limit: 100000 // The amount of names in the current subscription period
X-Rate-Limit-Remaining: 1398 // The number of names left in the current subscription period
X-Rate-Reset: 13829 // Seconds remaining until a new subscription period starts

I am quite new in Github, I want to contribute here, but how to.

Can this code work with the Genderize.io bigger batch key?

I recently purchased the Genderize.io 100,000 a month key. Can genderize work with the key? I don't know where to put the key in the get function. Thanks!