Skip to main content

A terminal-based dating application for UTD students

Project description

Kuiper

A terminal-based dating application for UTD students, built with the curses API.

Installation

Unfamiliar with terminal stuff? Here's what you need to start using Kuiper:

  1. Install Python
  2. Open up your terminal or command line
  3. Type in python3 -m pip install kuiper. You may receive some nasty output, that's alright. Mac users might need to install XCode tools
  4. Now you're ready to use Kuiper! Just type kuiper into your command line, and the TUI should boot.

Usage

$ kuiper                       # Start the TUI
$ kuiper -c USERNAME PASSWORD  # Login with credentials
$ kuiper -d                    # Print configs
$ kuiper -i                    # Initialize the database
$ kuiper -h                    # View the help menu
$ kuiper -l new_configs.yaml   # Update server configs
$ kuiper --local_server        # Connect to localhost server
$ kuiper -q                    # Suppress server output
$ kuiper -s                    # Start server

Menu navigation is controlled by the up and down arrow keys.

When filling out a form field, the string in the bottom-right corner is the current buffer. Hit "Enter" to save the form field.

Configs

The follow are the configuration options supported by Kuiper.

To modify Kuiper's configs, create a config.yaml file with the keys and values you'd like to overwrite, and call kuiper -l config.yaml

Config Default Value Description
bind_host "127.0.0.1" The address on which the server will be hosted via kuiper -s
port 8000 The port on which the server will be hosted via kuiper -s
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
db_path "kuiper.db" The path to the server's user and post database
required_email_suffix "@utdallas.edu" The email suffix required during registration. For no requirement, set to ""
org_name "UTD" The organization name to be displayed at login and registration
server_email_username/password None/None The login information for the email the server will use to send email verification codes
server_email_smtp_addr/port "smtp.gmail.com"/465 The SMTP address/port used to send emails
text_editor "vim" The text editor called via the subprocess module to write posts and comments

Inspiration

UTD Bruh Moments IG Post

Original Reddit Post

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kuiper-0.8.6.tar.gz (35.1 kB view details)

Uploaded Source

Built Distribution

kuiper-0.8.6-py3-none-any.whl (34.5 kB view details)

Uploaded Python 3

File details

Details for the file kuiper-0.8.6.tar.gz.

File metadata

  • Download URL: kuiper-0.8.6.tar.gz
  • Upload date:
  • Size: 35.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.7.6 Darwin/19.6.0

File hashes

Hashes for kuiper-0.8.6.tar.gz
Algorithm Hash digest
SHA256 a855b66fbcd68434fec39426d4b5ea46e8eb8642c424092e79106adfe372ebcf
MD5 98344e72451d8bc1e8cf3a22ac97daf9
BLAKE2b-256 65fe5aa0e6b3aa9d8eed0e3e2257efcc8912b56c6890f7cc6dbef50829a921b2

See more details on using hashes here.

File details

Details for the file kuiper-0.8.6-py3-none-any.whl.

File metadata

  • Download URL: kuiper-0.8.6-py3-none-any.whl
  • Upload date:
  • Size: 34.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.7.6 Darwin/19.6.0

File hashes

Hashes for kuiper-0.8.6-py3-none-any.whl
Algorithm Hash digest
SHA256 401394cfee72be487fb04921d74b519d9f5616575d1d391a0e48dee5f4bd7db8
MD5 0a4b7b0bf15feb41f9f02fbab52f9911
BLAKE2b-256 ec9a399aa4d626d4720b2c8bbac091fb3dbdb55cf53637499930fce5fdea91bf

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page