update readme

Author: fengyifan

README.md

@@ -6,7 +6,7 @@
   <!-- <a href="https://hyperdb.netlify.app">Demo</a> -->
 </div>
 
-<h1 align="center">Hyper-DB</h1>
+<h1 align="center">Hypergraph-DB</h1>
 
 <p align="center">
   <img alt="Github top language" src="https://img.shields.io/github/languages/top/iMoonLab/Hyper-DB?color=800080">
@@ -46,9 +46,9 @@
 
 ## :dart: About ##
 
-Hyper-DB is a lightweight, flexible, and Python-based database designed to model and manage **hypergraphs**—a generalized graph structure where edges (hyperedges) can connect any number of vertices. This makes Hyper-DB an ideal solution for representing complex relationships between entities in various domains, such as knowledge graphs, social networks, and scientific data modeling.
+Hypergraph-DB is a lightweight, flexible, and Python-based database designed to model and manage **hypergraphs**—a generalized graph structure where edges (hyperedges) can connect any number of vertices. This makes Hypergraph-DB an ideal solution for representing complex relationships between entities in various domains, such as knowledge graphs, social networks, and scientific data modeling.
 
-Hyper-DB provides a high-level abstraction for working with vertices and hyperedges, making it easy to add, update, query, and manage hypergraph data. With built-in support for persistence, caching, and efficient operations, Hyper-DB simplifies the management of hypergraph data structures.
+Hypergraph-DB provides a high-level abstraction for working with vertices and hyperedges, making it easy to add, update, query, and manage hypergraph data. With built-in support for persistence, caching, and efficient operations, Hypergraph-DB simplifies the management of hypergraph data structures.
 
 ---
 
@@ -77,10 +77,10 @@ Hyper-DB provides a high-level abstraction for working with vertices and hypered
 ## :rocket: Installation ##
 
 
-Hyper-DB is a Python library. You can install it directly from PyPI using `pip`.
+Hypergraph-DB is a Python library. You can install it directly from PyPI using `pip`.
 
 ```bash
-pip install Hyper-DB
+pip install hypergraph-db
 ```
 
 You can also install it by cloning the repository or adding it to your project manually. Ensure you have Python 3.10 or later installed.
@@ -98,7 +98,7 @@ pip install -r requirements.txt
 
 ## :checkered_flag: Starting ##
 
-This section provides a quick guide to get started with Hyper-DB, including iusage, and running basic operations. Below is an example of how to use Hyper-DB, based on the provided test cases.
+This section provides a quick guide to get started with Hypergraph-DB, including iusage, and running basic operations. Below is an example of how to use Hypergraph-DB, based on the provided test cases.
 
 #### **1. Create a Hypergraph**
 
@@ -188,14 +188,14 @@ print(hg2.all_e)  # Output: {(1, 3, 4)}
 
 ## :memo: License ##
 
-Hyper-DB is open-source and licensed under the [Apache License 2.0](LICENSE). Feel free to use, modify, and distribute it as per the license terms.
+Hypergraph-DB is open-source and licensed under the [Apache License 2.0](LICENSE). Feel free to use, modify, and distribute it as per the license terms.
 
 
 ---
 
 ## :email: Contact ##
 
-Hyper-DB is maintained by [iMoon-Lab](http://moon-lab.tech/), Tsinghua University. If you have any questions, please feel free to contact us via email: [Yifan Feng](mailto:[email protected]).
+Hypergraph-DB is maintained by [iMoon-Lab](http://moon-lab.tech/), Tsinghua University. If you have any questions, please feel free to contact us via email: [Yifan Feng](mailto:[email protected]).
 
 
 Made with :heart: by <a href="https://github.com/yifanfeng97" target="_blank">Yifan Feng</a>

docs/.DS_Store

@@ -1,12 +1,9 @@
 Hyper-DB
 ==============
 
-Hypergraph DataBase
----------------------
-
 .. autoclass:: hyperdb.BaseHypergraphDB
     :members:
 
-
 .. autoclass:: hyperdb.HypergraphDB
     :members:
+    :show-inheritance:

docs/_static/css/hyper_db.css docs/_static/css/hyperdb.cssdocs/_static/css/hyper_db.css renamed to docs/_static/css/hyperdb.css

@@ -30,7 +30,7 @@ def find_version(filename):
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'Hyper-DB'
+project = 'Hypergraph-DB'
 copyright = '2024, Yifan Feng'
 author = 'Yifan Feng'
 release = find_version("../hyperdb/__init__.py")
@@ -70,13 +70,14 @@ def find_version(filename):
 import sphinx_rtd_theme
 
 html_theme = 'sphinx_rtd_theme'
-# html_logo = "_static/logo_DHG_white.svg"
+# html_logo = "_static/logo_hyperdb_white.svg"
+html_logo = "_static/logo.svg"
 html_theme_options = {
     # "style_nav_header_background": "#9C27B0",
-    "logo_only": True,
+    # "logo_only": True,
     "collapse_navigation": False,
 }
 html_static_path = ['_static']
 
 def setup(app):
-    app.add_css_file("css/hyper_db.css")
+    app.add_css_file("css/hyperdb.css")

docs/api/hyperdb.rst

@@ -0,0 +1,3 @@
+Preliminaries of Hypergraph
+=================================
+

docs/conf.py

@@ -8,19 +8,19 @@ Installation
 
 - Python >= 3.10
 
-Current, the stable version of **Hyper-DB** is 0.1.0. You can install it with ``pip`` as follows:
+Current, the stable version of **Hypergraph-DB** is 0.1.0. You can install it with ``pip`` as follows:
 
 .. code-block:: bash
 
-    pip install Hyper-DB
+    pip install hypergraph-db
 
-You can also try the nightly version (0.1.1) of **Hyper-DB** library with ``pip`` as follows:
+You can also try the nightly version (0.1.1) of **Hypergraph-DB** library with ``pip`` as follows:
 
 .. code-block:: bash
 
     pip install git+https://github.com/iMoonLab/Hyper-DB.git
 
 .. note:: 
 
-    Nightly version is the development version of **Hyper-DB**. It can also be unstable and not fully tested. 
+    Nightly version is the development version of **Hypergraph-DB**. It can also be unstable and not fully tested. 
     If you find any bugs, please report it to us in `GitHub Issues <https://github.com/iMoonLab/Hyper-DB/issues>`_.

docs/get_started/hypergraph.rst

@@ -3,19 +3,28 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Hyper-DB documentation
-======================
+========================
+Hypergraph-DB Overview
+========================
 
-Add your content using ``reStructuredText`` syntax. See the
-`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
-documentation for details.
+Hypergraph-DB is a lightweight, flexible, and Python-based database designed to model and manage **hypergraphs**—a generalized graph structure where edges (hyperedges) can connect any number of vertices. This makes Hypergraph-DB an ideal solution for representing complex relationships between entities in various domains, such as knowledge graphs, social networks, and scientific data modeling.
 
+Hypergraph-DB provides a high-level abstraction for working with vertices and hyperedges, making it easy to add, update, query, and manage hypergraph data. With built-in support for persistence, caching, and efficient operations, Hypergraph-DB simplifies the management of hypergraph data structures.
+
+**News**
+
+- 2024-12-16 -> The **v0.1.0** is now available! 
+
+.. ======================================================
+
+.. decumment for html
 
 .. toctree::
    :maxdepth: 2
    :caption: Get Started
 
    get_started/install
+   get_started/hypergraph
 
 .. toctree::
    :maxdepth: 2

docs/get_started/install.rst

@@ -1,13 +1,44 @@
 [tool.poetry]
-name = "hyper-db"
+name = "hypergraph-db"
 version = "0.1.0"
 description = "A Lightweight Hypergraph Database"
-authors = ["[email protected]"]
+authors = ["Yifan Feng <[email protected]>"]
+license = "Apache-2.0"
 readme = "README.md"
+repository = "https://github.com/iMoonLab/Hyper-DB"
+keywords = ["hypergraph", "database", "visualization"]
+packages = [
+    { include = "hyperdb" },
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Mathematics",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Software Development",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "License :: OSI Approved :: Apache Software License",
+]
+
 
 [tool.poetry.dependencies]
 python = "^3.10"
 
+[tool.black]
+include = '\.pyi?$'
+line-length = 119
+
+[tool.isort]
+profile = "black"
+line_length = 119
 
 [build-system]
 requires = ["poetry-core"]