11# -*- coding: utf-8 -*-
2- """Setup for openai_embeddings package."""
2+ """
3+ Future use: setup for openai_embeddings package. I use this for instructional purposes,
4+ for demonstrating best practices on how to create a Python package.
5+
6+ This package is not actually published to PyPi.
7+ """
38import io
49import os
510from typing import List
@@ -24,6 +29,13 @@ def load_requirements(filename: str) -> List[str]:
2429 """
2530 Returns Python package requirements as a list of semantically
2631 versioned pip packages.
32+
33+ Args:
34+ filename: The name of the requirements file to load. example: "base.txt"
35+
36+ Returns:
37+ A list of package requirements.
38+ ['pytest==8.3.4', 'pytest_mock==3.14.0', 'black==25.1.0', ... more packages ]
2739 """
2840 with io .open (os .path .join (HERE , "requirements" , filename ), "rt" , encoding = "utf-8" ) as f :
2941 return [line .strip () for line in f if is_requirement (line ) and not line .startswith ("-r" )]
@@ -38,6 +50,7 @@ def load_requirements(filename: str) -> List[str]:
3850 managed by [LangChain](https://www.langchain.com/).""" ,
3951 author = "Lawrence McDaniel" ,
4052 author_email = "lpm0073@gmail.com" ,
53+ url = "https://lawrencemcdaniel.com/" ,
4154 packages = find_packages (),
4255 package_data = {
4356 "openai_embeddings" : ["*.md" ],
0 commit comments