Skip to content
This repository has been archived by the owner on Jun 15, 2024. It is now read-only.

Commit

Permalink
chore: update actions & change to use pyproject.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
doomspec committed Oct 9, 2023
1 parent 0410efc commit da07d0f
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/analyze.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,5 @@ jobs:
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/.vuepress/dist/
force_orphan: true
force_orphan: true
cname: evonote.org
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

![Evomark](./docs/evonote.svg)

<center>
<div style="text-align: center;">
<a href="https://evonote.org">Webiste</a> | <a href="https://evonote.org/html/project_tree.html">ProjectTree</a>
</center>
</div>

## Why knowledge base?

Expand Down Expand Up @@ -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

Expand Down
19 changes: 18 additions & 1 deletion docs/development/index.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
32 changes: 32 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -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"]

0 comments on commit da07d0f

Please sign in to comment.