1
1
# -*- 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
+ """
3
8
import io
4
9
import os
5
10
from typing import List
@@ -24,6 +29,13 @@ def load_requirements(filename: str) -> List[str]:
24
29
"""
25
30
Returns Python package requirements as a list of semantically
26
31
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 ]
27
39
"""
28
40
with io .open (os .path .join (HERE , "requirements" , filename ), "rt" , encoding = "utf-8" ) as f :
29
41
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]:
38
50
managed by [LangChain](https://www.langchain.com/).""" ,
39
51
author = "Lawrence McDaniel" ,
40
52
author_email = "lpm0073@gmail.com" ,
53
+ url = "https://lawrencemcdaniel.com/" ,
41
54
packages = find_packages (),
42
55
package_data = {
43
56
"openai_embeddings" : ["*.md" ],
0 commit comments