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

Uploaded Source

Built Distribution

kuiper-0.7.0-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kuiper-0.7.0.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.0.tar.gz
Algorithm Hash digest
SHA256 2e4bead143d9299eeeff90e0baf9a5e24e9048335b18f65d02c0f9311a1300a6
MD5 7f29dc1127d9c2c86fceaa206d50cdd5
BLAKE2b-256 33a1601e7ca33d47ffd509b7071d98de753add53c6fa90f5070fb9d9a24645c5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kuiper-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 31.8 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 905080d1d08ce3a0bfdfed67bf558d1691bc044232f1602fa93d449223bba150
MD5 b9e013468deece59e05f539352590ebe
BLAKE2b-256 ba68e60a6fba48fe381356d42f88b30a03f47e4a01593afad77bda6fd6ad2a55

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