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 ""
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.7.1.tar.gz (31.6 kB view details)

Uploaded Source

Built Distribution

kuiper-0.7.1-py3-none-any.whl (31.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kuiper-0.7.1.tar.gz
  • Upload date:
  • Size: 31.6 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.7.1.tar.gz
Algorithm Hash digest
SHA256 983604fe4b3666074d9fe1f004a45b630a6fafd172f5f00913b7823dc27350cd
MD5 ce3ef4a9f4bf8b68438fd55fe7c6923e
BLAKE2b-256 4be93a74ed7546c3fd2bb9390e0f8e58dbda3ea9584e81929ce2a07e10dfa318

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kuiper-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 31.9 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.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8fad763bd5bab21c8689f6fee763b9f400631deaab7ea15156b8652bc19a2c6b
MD5 453d682948577468a9d98fc1b1b21aab
BLAKE2b-256 af53d485faaf22532eef0e74751320c38c6a5ef192736defd688c0e8008c4371

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