xraymemory / pyokc

Programatically interact with OKCupid

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

pyokc

pyokc is a Python 3 package for interacting with OKCupid.com that was inspired by this guy (sort of).

Use

First things first

Go to settings.py and assign your OKCupid profile name to USERNAME and your password to PASSWORD. From now on you won't need to enter either for any pyokc scripts.

Starting a new session

from pyokc import pyokc

u = pyokc.User()

Messaging another user

u.message('foxylady899', 'Do you have a map?')

Searching profiles

profile_list = u.search(age_min=26, age_max=32)

Just like OKCupid, pyokc uses default search values if you haven't specified a particular value. For instance, if you do not state a search location or radius, the profiles returned will be within a 25-mile radius of your profile's location. By default, search returns 18 profiles, however this can be changed with the number keyword parameter. You can search using every metric that OKCupid currently allows, with the exception of A-list only options. The objects returned in the list are Profile objects that contain basic information about a profile as attributes such as name, age, and match. The actual content of a profile, however, cannot be accessed without actually visiting the profile.

Visiting a profile

u.visit('foxylady899') or u.visit(profile_list[0]) The argument passed to visit can either be a string username or a Profile object. Note that this will cause you to show up in that user's visitors list, unless you've turned on invisible browsing. Once you have visited a profile, you should have access to just about every piece of information that is also available on the website. You can check out the docstrings and source code of the Profile class in pyokc.py to get a better idea of what is available to you.

Rating a profile

u.rate('foxylady899', 5)

User/Profile questions

The questions that you or someone else have answered can be accessed as a list via the questions attribute of User or Profile, respectively. Because getting this information can involve a time-consuming number of requests, you must first manually fill this list via the User.update_questions() or Profile.update_questions() methods. You can then access Question information via attributes like q.text and q.user_answer.

Mailbox

first_thread = u.inbox[0]

u.read(first_thread)

print(first_thread.messages)

Because reading each thread requires a request to the server, you must first pass a MessageThread object as an argument to User.read() before its messages attribute will become available.

Installation

pip install pyokc

pyokc has two dependencies: requests and lxml.

Note: Windows users will likely run into issues installing lxml. If this happens, be sure to install the binaries here and then use pip again.

FAQ

Why is my program going slowly?

pyokc overrides the get and post methods of Requests.Session to include a 3-second delay between requests to OKCupid. Hopefully, this will prevent someone from making too many requests in too short of a timespan and bringing down the wrath of the OKCupid powers-that-be. This length of time can be modified by changing the number assigned to DELAY in settings.py.

Why is x/y/z giving me an error message?

OKCupid updates its site frequently, and it can be difficult to keep up. If you run into an error, feel free to create an issue or send a pull request, and I'll get to it as quickly as possible.

ezoic increase your site revenue

About

Programatically interact with OKCupid

License:MIT License


Languages

Language:Python 100.0%