forked from guardrails-ai/guardrails
-
Notifications
You must be signed in to change notification settings - Fork 0
/
setup.py
168 lines (140 loc) · 4.6 KB
/
setup.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
#!/usr/bin/env python
# -*- coding: utf-8 -*-
import io
import os
# Note: To use the 'upload' functionality of this file, you must:
# $ pipenv install twine --dev
import sys
from distutils.util import convert_path
from setuptools import Command, find_packages, setup
main_ns = {}
ver_path = convert_path("guardrails/version.py")
with open(ver_path) as ver_file:
exec(ver_file.read(), main_ns)
# Package meta-data.
NAME = "guardrails-ai"
DESCRIPTION = "Adding guardrails to large language models."
URL = "https://github.com/shreyar/guardrails"
EMAIL = "shreya.rajpal@gmail.com"
AUTHOR = "Shreya Rajpal"
REQUIRES_PYTHON = ">=3.7.0"
VERSION = main_ns["__version__"]
# What packages are required for this module to be executed?
REQUIRED = [
"lxml",
"openai",
"rich",
"eliot",
"eliot-tree",
"pydantic",
"typer",
"griffe",
"tenacity",
]
# Read in docs/requirements.txt
with open("docs/requirements.txt") as f:
DOCS_REQUIREMENTS = f.read().splitlines()
SQL_REQUIREMENTS = ["sqlvalidator", "sqlalchemy>=2.0.9", "sqlglot"]
SUMMARY_REQUIREMENTS = ["thefuzz", "nltk"]
VECTORDB_REQUIREMENTS = ["faiss-cpu", "numpy", "tiktoken"]
# What packages are optional?
EXTRAS = {
"dev": [
"black==22.12.0",
"isort>=5.12.0",
"flake8>=3.8.4",
"docformatter>=1.4",
"pytest-cov>=2.10.1",
"pre-commit>=2.9.3",
"twine",
"pytest-mock",
"pypdfium2",
"pytest",
*SQL_REQUIREMENTS,
*VECTORDB_REQUIREMENTS,
]
+ DOCS_REQUIREMENTS,
"sql": SQL_REQUIREMENTS,
"manifest": "manifest-ml",
"vectordb": VECTORDB_REQUIREMENTS,
"profanity": ["alt-profanity-check"],
"critique": ["inspiredco"],
"summary": SUMMARY_REQUIREMENTS,
}
# The rest you shouldn't have to touch too much :)
# ------------------------------------------------
# Except, perhaps the License and Trove Classifiers!
# If you do change the License, remember to change the Trove Classifier for that!
here = os.path.abspath(os.path.dirname(__file__))
# Import the README and use it as the long-description.
# Note: this will only work if 'README.md' is present in your MANIFEST.in file!
try:
with io.open(os.path.join(here, "README.md"), encoding="utf-8") as f:
long_description = "\n" + f.read()
except FileNotFoundError:
long_description = DESCRIPTION
# Load the package's __version__.py module as a dictionary.
about = {}
if not VERSION:
project_slug = NAME.lower().replace("-", "_").replace(" ", "_")
with open(os.path.join(here, project_slug, "__version__.py")) as f:
exec(f.read(), about)
else:
about["__version__"] = VERSION
class UploadCommand(Command):
"""Support setup.py upload."""
description = "Build and publish the package."
user_options = []
@staticmethod
def status(s):
"""Prints things in bold."""
print("\033[1m{0}\033[0m".format(s))
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
# Build the source and wheel.
self.status("Building Source and Wheel (universal) distribution…")
os.system("{0} setup.py sdist bdist_wheel --universal".format(sys.executable))
self.status("Uploading the package to PyPI via Twine…")
os.system("twine upload dist/*")
self.status("Pushing git tags…")
os.system("git tag v{0}".format(about["__version__"]))
os.system("git push --tags")
sys.exit()
# Where the magic happens:
setup(
name=NAME,
version=about["__version__"],
description=DESCRIPTION,
long_description=long_description,
long_description_content_type="text/markdown",
author=AUTHOR,
author_email=EMAIL,
python_requires=REQUIRES_PYTHON,
url=URL,
packages=find_packages(exclude=["tests", "*.tests", "*.tests.*", "tests.*"]),
# If your package is a single module, use this instead of 'packages':
# py_modules=['mypackage'],
# Add CLI for "guardrails" command, point to guardrails.cli:cli
entry_points={
"console_scripts": ["guardrails=guardrails.cli:cli"],
},
install_requires=REQUIRED,
include_package_data=True,
extras_require=EXTRAS,
license="Apache 2.0",
classifiers=[
# Trove classifiers
# Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
],
# $ setup.py publish support.
cmdclass={
"upload": UploadCommand,
},
)