{"id":20302436,"url":"https://github.com/charlesaverill/kuiper","last_synced_at":"2025-04-11T13:38:27.103Z","repository":{"id":48672009,"uuid":"383940048","full_name":"CharlesAverill/kuiper","owner":"CharlesAverill","description":"A terminal-based dating application for UTD students","archived":false,"fork":false,"pushed_at":"2021-07-17T03:10:39.000Z","size":613,"stargazers_count":10,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-08T23:27:09.533Z","etag":null,"topics":["cli","curses","dating","terminal-based","utdallas"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/kuiper/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CharlesAverill.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-07T22:36:48.000Z","updated_at":"2022-10-02T01:48:47.000Z","dependencies_parsed_at":"2022-08-27T07:32:04.480Z","dependency_job_id":null,"html_url":"https://github.com/CharlesAverill/kuiper","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CharlesAverill%2Fkuiper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CharlesAverill%2Fkuiper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CharlesAverill%2Fkuiper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CharlesAverill%2Fkuiper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CharlesAverill","download_url":"https://codeload.github.com/CharlesAverill/kuiper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248410372,"owners_count":21098775,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","curses","dating","terminal-based","utdallas"],"created_at":"2024-11-14T16:31:28.293Z","updated_at":"2025-04-11T13:38:27.080Z","avatar_url":"https://github.com/CharlesAverill.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kuiper\r\n\r\nA terminal-based dating application for UTD students, built with the `curses` API.\r\n\r\n## Installation\r\n\r\nUnfamiliar with terminal stuff? Here's what you need to start using Kuiper:\r\n\r\n1. [Install Python](https://www.python.org/downloads/release/python-379/)\r\n2. Open up your terminal or command line\r\n3. Type in `python3 -m pip install kuiper`. You may receive some nasty output, that's alright. Mac users might need to install XCode tools\r\n4. Now you're ready to use Kuiper! Just type `kuiper` into your command line, and the TUI should boot.\r\n\r\n## Usage\r\n```bash\r\n$ kuiper                       # Start the TUI\r\n$ kuiper -c USERNAME PASSWORD  # Login with credentials\r\n$ kuiper -d                    # Print configs\r\n$ kuiper -i                    # Initialize the database\r\n$ kuiper -h                    # View the help menu\r\n$ kuiper -l new_configs.yaml   # Update server configs\r\n$ kuiper --local_server        # Connect to localhost server\r\n$ kuiper -q                    # Suppress server output\r\n$ kuiper -s                    # Start server\r\n```\r\n\r\nMenu navigation is controlled by the up and down arrow keys.\r\n\r\nWhen filling out a form field, the string in the bottom-right corner is the current buffer. \r\nHit \"Enter\" to save the form field.\r\n\r\n## Configs\r\n\r\nThe follow are the configuration options supported by Kuiper. \r\n\r\nTo modify Kuiper's configs, create a `config.yaml` file with the keys and values you'd like to overwrite, \r\nand call `kuiper -l config.yaml`\r\n\r\n| Config | Default Value | Description |\r\n| --- | --- | --- |\r\n| bind_host | \"127.0.0.1\" | The address on which the server will be hosted via `kuiper -s` |\r\n| port | 8000 | The port on which the server will be hosted via `kuiper -s`\r\n| access_host | \"35.172.42.184\" | The address to the server the client will ping. The defualt value is the static IP address of Kuiper's main server |\r\n| db_path | \"kuiper.db\" | The path to the server's user and post database |\r\n| required_email_suffix | \"@utdallas.edu\" | The email suffix required during registration. For no requirement, set to `\"\"` |\r\n| org_name | \"UTD\" | The organization name to be displayed at login and registration |\r\n| server_email_username/password | None/None | The login information for the email the server will use to send email verification codes |\r\n| server_email_smtp_addr/port | \"smtp.gmail.com\"/465 | The SMTP address/port used to send emails |\r\n| text_editor | \"vim\" | The text editor called via the `subprocess` module to write posts and comments |\r\n\r\n\r\n## Inspiration\r\n[UTD Bruh Moments IG Post](https://www.instagram.com/p/CRCJhEmpbI0/)\r\n\r\n[Original Reddit Post](https://www.reddit.com/r/utdallas/comments/od9roi/how_easy_is_it_to_find_men_above_the_age_of_23_at/)\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharlesaverill%2Fkuiper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcharlesaverill%2Fkuiper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharlesaverill%2Fkuiper/lists"}