sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-11-23 15:38:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Prepare Khoj for PyPi. Include Readme in dist, Fix metadata in setup.py

Browse source
This commit is contained in:
Debanjum Singh Solanky 2022-08-02 22:26:31 +03:00
parent d57bd41019
commit 765e10bc2c
4 changed files with 18 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.gitignore vendored
View file

@ -4,8 +4,10 @@ __pycache__
tests/data/models tests/data/models
tests/data/embeddings tests/data/embeddings
src/.data src/.data
/src/interface/web/images
.vscode .vscode
*.gz *.gz
*.pt *.pt
/src/interface/web/*.jpg /build/
/src/interface/web/*.png /dist/
/khoj_assistant.egg-info/

3
MANIFEST.in Normal file
View file

@ -0,0 +1,3 @@
include Readme.md
graft docs*
global-exclude .DS_Store *.py[cod]

9
Readme.md
View file

@ -128,9 +128,8 @@ docker-compose build --pull
2. Install Khoj 2. Install Khoj
``` shell ``` shell
git clone https://github.com/debanjum/khoj && cd khoj virtualenv -m python3 .venv && source .venv/bin/activate # Optional
virtualenv -m python3 .venv && source .venv/bin/activate pip install khoj-assistant
pip install .
``` ```
3. Configure 3. Configure
@ -176,9 +175,7 @@ docker-compose build --pull
### Upgrade On Local Machine ### Upgrade On Local Machine
#### Using Pip #### Using Pip
``` shell ``` shell
cd khoj pip install --upgrade khoj-assistant
git pull origin master
pip install --upgrade .
``` ```
#### Using Conda #### Using Conda

13
setup.py
View file

@ -2,17 +2,20 @@
from setuptools import find_packages, setup from setuptools import find_packages, setup
from pathlib import Path
this_directory = Path(__file__).parent
setup( setup(
name='khoj', name='khoj-assistant',
version='1.0', version='0.1',
description="A natural language search engine for your personal notes, transactions and images", 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", long_description_content_type="text/markdown",
author='Debanjum Singh Solanky, Saba Imran', 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', url='https://github.com/debanjum/khoj',
license="GPLv3", 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", python_requires=">=3.5, <4",
packages=find_packages( packages=find_packages(
where=".", where=".",