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

Uploaded Source

Built Distribution

kuiper-0.6.4-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kuiper-0.6.4.tar.gz
  • Upload date:
  • Size: 17.9 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.6.4.tar.gz
Algorithm Hash digest
SHA256 1d23b2ec2699a3730abd85762a2ada1fd122fd858eef35753c1b293874c720e5
MD5 ccd3a310868cf855b02596012f2cc610
BLAKE2b-256 1dd1b0bf94b45e063014587e64e11bcd53938a789c1c5c35ebc3f74182dbc7f8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kuiper-0.6.4-py3-none-any.whl
  • Upload date:
  • Size: 18.3 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.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7d542f8d89f0182989d70bb9ce59c48fa76c83fd072639cf4b669e971f2c39a6
MD5 122a969f84e0b6e26b58119a862cf630
BLAKE2b-256 af04234e20bee32d220b5ec18f01ad0e0eb6a37a9423725c433808aad5466b44

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