mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-11-23 15:38:55 +01:00
Prepare Khoj for PyPi. Include Readme in dist, Fix metadata in setup.py
This commit is contained in:
parent
d57bd41019
commit
765e10bc2c
4 changed files with 18 additions and 13 deletions
6
.gitignore
vendored
6
.gitignore
vendored
|
@ -4,8 +4,10 @@ __pycache__
|
|||
tests/data/models
|
||||
tests/data/embeddings
|
||||
src/.data
|
||||
/src/interface/web/images
|
||||
.vscode
|
||||
*.gz
|
||||
*.pt
|
||||
/src/interface/web/*.jpg
|
||||
/src/interface/web/*.png
|
||||
/build/
|
||||
/dist/
|
||||
/khoj_assistant.egg-info/
|
||||
|
|
3
MANIFEST.in
Normal file
3
MANIFEST.in
Normal file
|
@ -0,0 +1,3 @@
|
|||
include Readme.md
|
||||
graft docs*
|
||||
global-exclude .DS_Store *.py[cod]
|
|
@ -128,9 +128,8 @@ docker-compose build --pull
|
|||
|
||||
2. Install Khoj
|
||||
``` shell
|
||||
git clone https://github.com/debanjum/khoj && cd khoj
|
||||
virtualenv -m python3 .venv && source .venv/bin/activate
|
||||
pip install .
|
||||
virtualenv -m python3 .venv && source .venv/bin/activate # Optional
|
||||
pip install khoj-assistant
|
||||
```
|
||||
|
||||
3. Configure
|
||||
|
@ -176,9 +175,7 @@ docker-compose build --pull
|
|||
### Upgrade On Local Machine
|
||||
#### Using Pip
|
||||
``` shell
|
||||
cd khoj
|
||||
git pull origin master
|
||||
pip install --upgrade .
|
||||
pip install --upgrade khoj-assistant
|
||||
```
|
||||
|
||||
#### Using Conda
|
||||
|
|
13
setup.py
13
setup.py
|
@ -2,17 +2,20 @@
|
|||
|
||||
from setuptools import find_packages, setup
|
||||
|
||||
from pathlib import Path
|
||||
this_directory = Path(__file__).parent
|
||||
|
||||
setup(
|
||||
name='khoj',
|
||||
version='1.0',
|
||||
name='khoj-assistant',
|
||||
version='0.1',
|
||||
description="A natural language search engine for your personal notes, transactions and images",
|
||||
long_description=open('Readme.md', "r", encoding="utf-8").read(),
|
||||
long_description=(this_directory / "Readme.md").read_text(encoding="utf-8"),
|
||||
long_description_content_type="text/markdown",
|
||||
author='Debanjum Singh Solanky, Saba Imran',
|
||||
author_email='debanjum@gmail.com',
|
||||
author_email='debanjum+pypi@gmail.com, narmiabas@gmail.com',
|
||||
url='https://github.com/debanjum/khoj',
|
||||
license="GPLv3",
|
||||
keywords="search semantic-search NLP sentence-transformer org-mode markdown beancount images",
|
||||
keywords="search semantic-search productivity NLP org-mode markdown beancount images",
|
||||
python_requires=">=3.5, <4",
|
||||
packages=find_packages(
|
||||
where=".",
|
||||
|
|
Loading…
Reference in a new issue