diff --git a/README.md b/README.md index 9d7fd392f..718687999 100644 --- a/README.md +++ b/README.md @@ -185,7 +185,7 @@ We provide a user interface for Gradio, which allows you to use DB-GPT through o To use multiple models, modify the LLM_MODEL parameter in the .env configuration file to switch between the models. -####Create your own knowledge repository: +### Create your own knowledge repository: 1.Place personal knowledge files or folders in the pilot/datasets directory. @@ -213,7 +213,7 @@ Run the Python interpreter and type the commands: ## Acknowledgement -The achievements of this project are thanks to the technical community, especially the following projects: +This project is standing on the shoulders of giants and is not going to work without the open-source communities. Special thanks to the following projects for their excellent contribution to the AI industry: - [FastChat](https://github.com/lm-sys/FastChat) for providing chat services - [vicuna-13b](https://lmsys.org/blog/2023-03-30-vicuna/) as the base model - [langchain](https://langchain.readthedocs.io/) tool chain @@ -245,4 +245,4 @@ This project follows the git-contributor [spec](https://github.com/xudafeng/git- The MIT License (MIT) ## Contact Information -We are working on building a community, if you have any ideas about building the community, feel free to contact us. [Discord](https://discord.com/invite/twmZk3vv) +We are working on building a community, if you have any ideas about building the community, feel free to contact us. [Discord](https://discord.gg/kMFf77FH) diff --git a/docs/conf.py b/docs/conf.py index ba156d994..9ea8cb3aa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -7,16 +7,14 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information import toml +import os +import sys project = "DB-GPT" copyright = "2023, csunny" author = "csunny" -with open("../pyproject.toml") as f: - data = toml.load(f) - -version = data["tool"]["poetry"]["version"] -release = version +version = "0.1.0" html_title = project + " " + version # -- General configuration --------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 603ac2049..2b33ed0be 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -89,7 +89,7 @@ Use Cases | Best Practices and built-in implementations for common DB-GPT use cases: -- `Sql generation and diagnosis <./use_cases/sql_generation_and_diagnosis.html>`: SQL generation and diagnosis. +- `Sql generation and diagnosis <./use_cases/sql_generation_and_diagnosis.html>`_: SQL generation and diagnosis. - `knownledge Based QA <./use_cases/knownledge_based_qa.html>`_: A important scene for user to chat with database documents, codes, bugs and schemas. diff --git a/pyproject.toml b/pyproject.toml deleted file mode 100644 index 12834cedd..000000000 --- a/pyproject.toml +++ /dev/null @@ -1,49 +0,0 @@ -[tool.poetry] -name = "db-gpt" -version = "0.0.6" -description = "Interact with your data and environment privately" -authors = [] -readme = "README.md" -license = "MIT" -packages = [{include = "db_gpt"}] -repository = "https://www.github.com/csunny/DB-GPT" - -[tool.poetry.dependencies] -python = "^3.10" -accelerate = "^0.16" - - -[tool.poetry.group.docs.dependencies] -autodoc_pydantic = "^1.8.0" -myst_parser = "^0.18.1" -nbsphinx = "^0.8.9" -sphinx = "^4.5.0" -sphinx-autobuild = "^2021.3.14" -sphinx_book_theme = "^0.3.3" -sphinx_rtd_theme = "^1.0.0" -sphinx-typlog-theme = "^0.8.0" -sphinx-panels = "^0.6.0" -toml = "^0.10.2" -myst-nb = "^0.17.1" -linkchecker = "^10.2.1" -sphinx-copybutton = "^0.5.1" - -[tool.poetry.group.test.dependencies] -# The only dependencies that should be added are -# dependencies used for running tests (e.g., pytest, freezegun, response). -# Any dependencies that do not meet that criteria will be removed. -pytest = "^7.3.0" -pytest-cov = "^4.0.0" -pytest-dotenv = "^0.5.2" -duckdb-engine = "^0.7.0" -pytest-watcher = "^0.2.6" -freezegun = "^1.2.2" -responses = "^0.22.0" -pytest-asyncio = "^0.20.3" -lark = "^1.1.5" -pytest-mock = "^3.10.0" -pytest-socket = "^0.6.0" - -[build-system] -requires = ["poetry-core"] -build-backend = "poetry.core.masonry.api" diff --git a/setup.py b/setup.py new file mode 100644 index 000000000..43ab7ccd9 --- /dev/null +++ b/setup.py @@ -0,0 +1,37 @@ +from typing import List + +import setuptools +from setuptools import find_packages + +with open("README.md", "r") as fh: + long_description = fh.read() + + +def parse_requirements(file_name: str) -> List[str]: + with open(file_name) as f: + return [ + require.strip() for require in f + if require.strip() and not require.startswith('#') + ] + + +setuptools.setup( + name="DB-GPT", + packages=find_packages(), + version="0.1.0", + author="csunny", + author_email="cfqcsunny@gmail.com", + description="DB-GPT is an experimental open-source project that uses localized GPT large models to interact with your data and environment." + " With this solution, you can be assured that there is no risk of data leakage, and your data is 100% private and secure.", + long_description=long_description, + long_description_content_type="text/markdown", + install_requires=parse_requirements('requirements.txt'), + url="https://github.com/csunny/DB-GPT", + license='https://opensource.org/license/mit/', + python_requires='>=3.10', + entry_points={ + 'console_scripts': [ + 'dbgpt_server=pilot.server:webserver', + ], + }, +)