Skip to content

jjl9930/3-python-package-team_quartz

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pyflirt

A Python package that gives you developer-themed pickup lines and compliments. Because coding should be fun.

What is this?

This package has a collection of cheesy (but configurable) pickup lines and compliments for developers, designers, managers, and data scientists. You can get random lines, filter by category, adjust the cheesiness level, and customize compliments.

Installation

pip install pyflirt

Quick Start

from pyflirt import line, lines, compliment, categories

# Get one random pickup line
print(line())

# Get a line in a specific category
print(line(category="nerdy"))

# Get multiple lines
print(lines(n=5, category="cs"))

# Get a compliment
print(compliment(role="developer", mood="sweet"))

Functions

line(category="nerdy", name=None, cheese=2, seed=None)

Returns one random pickup line.

  • category: Pick a category like "nerdy", "cs", "math", "poetic", or "classic". Default is "nerdy".
  • name: If the line supports it, this name will be inserted.
  • cheese: How cheesy should it be? 1 (least cheesy) to 5 (very cheesy). Default is 2.
  • seed: Optional number for reproducible results.

Example:

line(category="cs", name="Alex", cheese=2)

lines(n=5, category=None, name=None, cheese=2, seed=None)

Returns a list of pickup lines.

  • n: How many lines you want.
  • Other parameters work the same as line().

Example:

lines(n=3, category="math", cheese=3)

compliment(role="developer", mood="sweet", name=None, emojis=0, seed=None)

Returns a compliment for a specific role.

  • role: Choose from "developer", "designer", "manager", or "data".
  • mood: "sweet", "cheeky", or "nerdy".
  • name: Optional name to include in the compliment.
  • emojis: Number of heart emojis to add (0-5).
  • seed: Optional number for reproducible results.

Example:

compliment(role="designer", mood="cheeky", name="Sam", emojis=2)

categories()

Returns a list of all available pickup line categories.

Example:

print(categories())
# ['classic', 'cs', 'math', 'nerdy', 'poetic']

Development Setup

If you want to work on this package:

  1. Clone the repo:
git clone https://github.com/swe-students-fall2025/3-python-package-team_quartz.git
cd 3-python-package-team_quartz
  1. Install pipenv (if you don't have it):
pip install pipenv
  1. Install dependencies:
pipenv install --dev
  1. Activate the virtual environment:
pipenv shell
  1. Run tests:
pytest
  1. Build the package:
python -m build

Links

Contributors

See the contributors page for a list of everyone who worked on this project.

About

software-engineering-fall-2025-3-python-package-python-package-exercise created by GitHub Classroom

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 100.0%