From da07d0f0252e8084b571d4c3e0efb9fa98f6dc41 Mon Sep 17 00:00:00 2001 From: Zijian Zhang Date: Mon, 9 Oct 2023 00:38:27 -0400 Subject: [PATCH] chore: update actions & change to use pyproject.toml --- .github/workflows/analyze.yml | 2 +- .github/workflows/deploy.yml | 3 ++- README.md | 6 +++--- docs/development/index.md | 19 ++++++++++++++++++- pyproject.toml | 32 ++++++++++++++++++++++++++++++++ 5 files changed, 56 insertions(+), 6 deletions(-) create mode 100644 pyproject.toml diff --git a/.github/workflows/analyze.yml b/.github/workflows/analyze.yml index 8440824..d1df529 100644 --- a/.github/workflows/analyze.yml +++ b/.github/workflows/analyze.yml @@ -24,7 +24,7 @@ jobs: - name: Install dependencies 📦 run: | python -m pip install --upgrade pip - pip install -r requirements.txt + pip install . - name: build project tree📦 run: | diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 3d97c19..4fd3309 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -45,4 +45,5 @@ jobs: with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./docs/.vuepress/dist/ - force_orphan: true \ No newline at end of file + force_orphan: true + cname: evonote.org \ No newline at end of file diff --git a/README.md b/README.md index 3f9f3cb..a62ea39 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ ![Evomark](./docs/evonote.svg) -
+
Webiste | ProjectTree -
+ ## Why knowledge base? @@ -61,7 +61,7 @@ EvoNote is build for holding and operating knowledge in the form of `note trees` ## Installation -Currently, EvoNote is not ready for production usage. Please refer to the Development section for development usage. +Currently, EvoNote is not ready for production usage. Please refer to the [Development section](https://evonote.org/development) for development usage. ## Development diff --git a/docs/development/index.md b/docs/development/index.md index 6cdcb8f..9f4b719 100644 --- a/docs/development/index.md +++ b/docs/development/index.md @@ -1,4 +1,21 @@ -# Class +# Overall + +IDE recommendation: PyCharm + +Docstring style: rst + +## DocInPy + +Please use the [DocInPy](https://github.com/EvoEvolver/EvoNote/tree/main/doc_in_py) style for adding sections in the codes. + +## Installation + +```bash +git clone git@github.com:EvoEvolver/EvoNote.git +pip install -e . +``` + +# Classes ## Knowledge storage `Note`: The node of knowledge. It only contains the knowledge itself. diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..493e5fc --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,32 @@ +[build-system] +requires = ["setuptools", "setuptools-scm"] +build-backend = "setuptools.build_meta" + +[project] +name = "EvoNote" +description = "Knowledge-centered AI system" +version = "0.1.0" +authors = [ + { name = "Zijian Zhang" } +] + +dependencies = [ + "plotly==5.16.1", + "numpy==1.25.2", + "pyyaml~=6.0.1", + "openai==0.28.0", + "pyhyphen==4.0.3", + "dill~=0.3.7", + "html2text~=2020.1.16", + "markdownify~=0.11.6", + "bidict~=0.22.1", + "tenacity~=8.2.2" +] + +[project.optional-dependencies] +dev = [ + "pytest" +] + +[tool.setuptools] +packages = ["evonote", "doc_in_py"] \ No newline at end of file