graphreveal 0.1.0__tar.gz

graphreveal-0.1.0/.gitattributes

@@ -0,0 +1 @@
+src/graphreveal/translator/generated/* linguist-generated=true

graphreveal-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install the package
+        run: |
+          uv pip install .
+      - name: Run Ruff
+        run: uvx ruff check --output-format=github
+      - name: Run Ruff formatter
+        run: uvx ruff format --check
+      - name: Create the database
+        run: |
+          graphreveal create-database
+      - name: Run tests
+        run: uv run pytest

graphreveal-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+.idea/*
+
+__pycache__/
+*.egg-info
+
+graphs.db
+
+.antlr/
+*.interp
+*.tokens

graphreveal-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Michał Dobranowski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

graphreveal-0.1.0/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: graphreveal
+Version: 0.1.0
+Summary: Small graphs database and search system
+Project-URL: Changelog, https://github.com/mdbrnowski/GraphReveal/releases
+Project-URL: Homepage, https://github.com/mdbrnowski/GraphReveal
+Project-URL: Source, https://github.com/mdbrnowski/GraphReveal
+Author-email: Michał Dobranowski <mdbrnowski@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: database,graph-theory,graphs
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Topic :: Database
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.12
+Requires-Dist: antlr4-python3-runtime>=4.13.2
+Requires-Dist: networkx>=3.4.2
+Requires-Dist: platformdirs>=4.3.6
+Requires-Dist: rich>=13.9.4
+Requires-Dist: typer>=0.15.1
+Description-Content-Type: text/markdown
+
+# GraphReveal
+
+[![PyPI - Version](https://img.shields.io/pypi/v/graphreveal)](https://pypi.org/project/graphreveal/)
+[![Test](https://github.com/mdbrnowski/GraphReveal/actions/workflows/test.yml/badge.svg)](https://github.com/mdbrnowski/GraphReveal/actions/workflows/test.yml)
+
+Have you ever needed an example of a graph that, e.g., is Hamiltonian, has exactly 8 vertices, and can be drawn on a plane without intersecting edges? Or wondered how many graphs of size 10 are bipartite, have no isolated vertices, and have exactly two components?
+
+This package aims to answer some of your questions. You can search through all graphs with some reasonable order (currently 9 is the maximum) using a very simple DSL (*domain-specific language*).
+
+## Installation
+
+Make sure that you have Python in a sufficiently recent version. To install the package using `pip`, you can use the following command:
+
+```shell
+pip install graphreveal
+```
+
+## Basic usage
+
+Firstly, you should create the database:
+
+```shell
+graphreveal create-database
+```
+
+This process should take less than two seconds and will create a database of graphs with an order no larger than 7. To use a larger database, add `--n 8` or `--n 9` flag to this command.
+
+### Some examples
+
+```shell
+graphreveal search "10 edges, bipartite, no isolated vertices, 2 components"
+```
+
+```shell
+graphreveal search --count "6 vertices, connected"
+```
+
+### List of available properties
+
+* [int] `vertices` (alternatives: `verts`,`V`, `nodes`)
+* [int] `edges` (alternative: `E`)
+* [int] `blocks` (alternative: `biconnected components`)
+* [int] `components` (alternative: `C`)
+* `acyclic` (alternative: `forest`)
+* `bipartite`
+* `complete`
+* `connected`
+* `eulerian` (alternative: `euler`)
+* `hamiltonian` (alternative: `hamilton`)
+* `no isolated vertices` (alternatives: `no isolated v`, `niv`)
+* `planar`
+* `tree`
+
+You can also negate these properties using `!` or `not`.

graphreveal-0.1.0/README.md

@@ -0,0 +1,54 @@
+# GraphReveal
+
+[![PyPI - Version](https://img.shields.io/pypi/v/graphreveal)](https://pypi.org/project/graphreveal/)
+[![Test](https://github.com/mdbrnowski/GraphReveal/actions/workflows/test.yml/badge.svg)](https://github.com/mdbrnowski/GraphReveal/actions/workflows/test.yml)
+
+Have you ever needed an example of a graph that, e.g., is Hamiltonian, has exactly 8 vertices, and can be drawn on a plane without intersecting edges? Or wondered how many graphs of size 10 are bipartite, have no isolated vertices, and have exactly two components?
+
+This package aims to answer some of your questions. You can search through all graphs with some reasonable order (currently 9 is the maximum) using a very simple DSL (*domain-specific language*).
+
+## Installation
+
+Make sure that you have Python in a sufficiently recent version. To install the package using `pip`, you can use the following command:
+
+```shell
+pip install graphreveal
+```
+
+## Basic usage
+
+Firstly, you should create the database:
+
+```shell
+graphreveal create-database
+```
+
+This process should take less than two seconds and will create a database of graphs with an order no larger than 7. To use a larger database, add `--n 8` or `--n 9` flag to this command.
+
+### Some examples
+
+```shell
+graphreveal search "10 edges, bipartite, no isolated vertices, 2 components"
+```
+
+```shell
+graphreveal search --count "6 vertices, connected"
+```
+
+### List of available properties
+
+* [int] `vertices` (alternatives: `verts`,`V`, `nodes`)
+* [int] `edges` (alternative: `E`)
+* [int] `blocks` (alternative: `biconnected components`)
+* [int] `components` (alternative: `C`)
+* `acyclic` (alternative: `forest`)
+* `bipartite`
+* `complete`
+* `connected`
+* `eulerian` (alternative: `euler`)
+* `hamiltonian` (alternative: `hamilton`)
+* `no isolated vertices` (alternatives: `no isolated v`, `niv`)
+* `planar`
+* `tree`
+
+You can also negate these properties using `!` or `not`.

graphreveal-0.1.0/pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name = "graphreveal"
+version = "0.1.0"
+description = "Small graphs database and search system"
+readme = "README.md"
+authors = [
+    { name = "Michał Dobranowski", email = "mdbrnowski@gmail.com" }
+]
+license = "MIT"
+requires-python = ">=3.12"
+dependencies = [
+    "antlr4-python3-runtime>=4.13.2",
+    "networkx>=3.4.2",
+    "platformdirs>=4.3.6",
+    "rich>=13.9.4",
+    "typer>=0.15.1",
+]
+keywords = ["graphs", "graph-theory", "database"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python",
+    "Topic :: Database",
+    "Topic :: Scientific/Engineering :: Mathematics"
+]
+
+[project.urls]
+Changelog = "https://github.com/mdbrnowski/GraphReveal/releases"
+Homepage = "https://github.com/mdbrnowski/GraphReveal"
+Source = "https://github.com/mdbrnowski/GraphReveal"
+
+[project.scripts]
+graphreveal = "graphreveal.cli:app"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3.4",
+]
+
+[tool.ruff]
+exclude = ["generated"]

graphreveal-0.1.0/src/graphreveal/__init__.py

@@ -0,0 +1,25 @@
+import os
+import sqlite3
+
+from platformdirs import user_data_dir
+
+DATABASE_PATH = os.path.join(
+    user_data_dir(appname="graphreveal", appauthor="graphreveal"), "graphs.db"
+)
+
+
+class ParsingError(Exception):
+    def __init__(self, message: str, errors_coordinates: list[tuple[int, int, int]]):
+        # todo: show all errors, not just the first one
+        error_coordinates = errors_coordinates[0]
+        self.message = message
+        self.error_line, self.error_column, self.error_length = error_coordinates
+
+
+def get_ids(sql_query: str) -> list[str]:
+    sql_query = sql_query.replace("*", "id", 1)
+    con = sqlite3.connect(DATABASE_PATH)
+    cur = con.cursor()
+
+    result = cur.execute(sql_query).fetchall()
+    return [graph_id for (graph_id,) in result]

graphreveal-0.1.0/src/graphreveal/cli.py

@@ -0,0 +1,82 @@
+import os
+from sqlite3 import OperationalError
+
+import rich
+import typer
+from rich.prompt import Confirm
+
+from graphreveal import get_ids, ParsingError, DATABASE_PATH
+from graphreveal.db_creator import create_db
+from graphreveal.translator import translate
+
+app = typer.Typer(no_args_is_help=True)
+
+
+def _print_parsing_error(query: str, e: ParsingError):
+    rich.print("[bold red]Query error:\n")
+    for i, query_line in enumerate(query.split("\n"), start=1):
+        query_line += " "
+        if i == e.error_line:
+            rich.print(
+                f"  [not bold cyan]{query_line[: e.error_column]}"
+                f"[bold red]{query_line[e.error_column : e.error_column + e.error_length]}"
+                f"[not bold cyan]{query_line[e.error_column + e.error_length :]}"
+            )
+            rich.print(f"  {' ' * e.error_column}[red]{'^' * e.error_length}")
+        else:
+            rich.print(f"  [not bold cyan]{query_line}\n")
+    rich.print()
+
+
+@app.command()
+def search(query: str, count: bool = False):
+    """
+    Get all graphs with given properties.
+    """
+    try:
+        sql_query = translate(query)
+        if count:
+            print(len(get_ids(sql_query)))
+        else:
+            print("\n".join(get_ids(sql_query)))
+    except ParsingError as e:
+        _print_parsing_error(query, e)
+    except OperationalError as e:
+        rich.print("[bold red]Error:", str(e) + ".")
+        rich.print(
+            "Try to create the database first. Run `[cyan]graphreveal create-database[/cyan]`."
+        )
+
+
+@app.command()
+def create_database(n: int = 7):
+    """
+    Create the database.
+    """
+    if n > 9 or n < 1:
+        rich.print("[bold red]Error: Choose n between 1 and 9.")
+        return
+
+    try:
+        if not os.path.exists(DATABASE_PATH) or Confirm.ask(
+            "Are you sure you want to overwrite the database?"
+        ):
+            create_db(n)
+    except OperationalError as e:
+        rich.print("[bold red]Error:", str(e) + ".")
+
+
+@app.command()
+def to_sql(query: str):
+    """
+    Translate your query to SQL.
+    """
+    try:
+        sql_query = translate(query)
+        print(sql_query)
+    except ParsingError as e:
+        _print_parsing_error(query, e)
+
+
+if __name__ == "__main__":
+    app()

graphreveal-0.1.0/src/graphreveal/db_creator/__init__.py

@@ -0,0 +1 @@
+from .create import create_db as create_db

graphreveal-0.1.0/src/graphreveal/db_creator/create.py

@@ -0,0 +1,68 @@
+import importlib.resources
+import os
+import sqlite3
+
+import networkx as nx
+from rich.progress import track
+
+from graphreveal import DATABASE_PATH
+from . import util
+
+
+def create_db(max_n):
+    os.makedirs(os.path.dirname(DATABASE_PATH), exist_ok=True)
+    con = sqlite3.connect(DATABASE_PATH)
+    cur = con.cursor()
+
+    cur.execute("DROP TABLE IF EXISTS graphs")
+
+    cur.execute(
+        """ CREATE TABLE graphs (
+                id VARCHAR(20) PRIMARY KEY,
+                vertices INT NOT NULL,
+                edges INT NOT NULL,
+                acyclic BOOLEAN NOT NULL,
+                bipartite BOOLEAN NOT NULL,
+                eulerian BOOLEAN NOT NULL,
+                hamiltonian BOOLEAN NOT NULL,
+                planar BOOLEAN NOT NULL,
+                blocks INT NOT NULL,
+                components INT NOT NULL,
+                degree_max INT NOT NULL,
+                degree_min INT NOT NULL
+            )"""
+    )
+
+    all_graphs = []
+
+    for n in range(1, max_n + 1):
+        with (
+            importlib.resources.files("graphreveal")
+            / "db_creator"
+            / "data"
+            / f"graph{n}.g6"
+        ).open(encoding="utf-8") as f:
+            all_graphs += f.read().strip().split("\n")
+
+    for graph_g6 in track(all_graphs, description="Creating the database"):
+        graph = nx.from_graph6_bytes(str.encode(graph_g6))
+        cur.execute(
+            "INSERT INTO graphs VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)",
+            [
+                graph_g6,
+                graph.number_of_nodes(),
+                graph.number_of_edges(),
+                nx.is_forest(graph),
+                nx.is_bipartite(graph),
+                nx.is_eulerian(graph),
+                util.is_hamiltonian(graph),
+                nx.is_planar(graph),
+                len(list(nx.biconnected_components(graph))),
+                nx.number_connected_components(graph),
+                util.max_degree(graph),
+                util.min_degree(graph),
+            ],
+        )
+
+    con.commit()
+    con.close()

graphreveal-0.1.0/src/graphreveal/db_creator/data/graph1.g6

@@ -0,0 +1 @@
+@

graphreveal-0.1.0/src/graphreveal/db_creator/data/graph2.g6

@@ -0,0 +1,2 @@
+A?
+A_

graphreveal-0.1.0/src/graphreveal/db_creator/data/graph3.g6

@@ -0,0 +1,4 @@
+B?
+BO
+BW
+Bw

graphreveal-0.1.0/src/graphreveal/db_creator/data/graph4.g6

@@ -0,0 +1,11 @@
+C?
+CC
+CE
+CF
+CQ
+CT
+CU
+CV
+C]
+C^
+C~

graphreveal-0.1.0/src/graphreveal/db_creator/data/graph5.g6

@@ -0,0 +1,34 @@
+D??
+D?_
+D?o
+D?w
+D?{
+DCO
+DCW
+DCc
+DCo
+DCs
+DCw
+DC{
+DEk
+DEo
+DEs
+DEw
+DE{
+DFw
+DF{
+DQg
+DQo
+DQw
+DQ{
+DTk
+DTw
+DT{
+DUW
+DUw
+DU{
+DV{
+D]w
+D]{
+D^{
+D~{

graphreveal-0.1.0/src/graphreveal/db_creator/data/graph6.g6

@@ -0,0 +1,156 @@
+E???
+E?A?
+E?B?
+E?B_
+E?Bo
+E?Bw
+E?`?
+E?`_
+E?`o
+E?aG
+E?b?
+E?bG
+E?b_
+E?bg
+E?bo
+E?bw
+E?oo
+E?ow
+E?qg
+E?qo
+E?qw
+E?r?
+E?rG
+E?r_
+E?rg
+E?ro
+E?rw
+E?zO
+E?zW
+E?z_
+E?zg
+E?zo
+E?zw
+E?~o
+E?~w
+ECO_
+ECQO
+ECQ_
+ECQo
+ECR?
+ECRO
+ECRW
+ECR_
+ECRo
+ECRw
+ECX_
+ECXg
+ECYO
+ECYW
+ECZ?
+ECZG
+ECZO
+ECZW
+ECZ_
+ECZg
+ECZo
+ECZw
+ECeW
+ECfW
+ECfo
+ECfw
+ECpO
+ECpo
+ECqg
+ECrG
+ECrO
+ECrW
+ECr_
+ECrg
+ECro
+ECrw
+ECuw
+ECvW
+ECvo
+ECvw
+ECxo
+ECxw
+ECzW
+ECzg
+ECzo
+ECzw
+EC~o
+EC~w
+EEhW
+EEh_
+EEho
+EEhw
+EEiW
+EEio
+EEjW
+EEj_
+EEjo
+EEjw
+EElw
+EEno
+EEnw
+EErO
+EErW
+EEr_
+EEro
+EErw
+EEuw
+EEvW
+EEvo
+EEvw
+EEzO
+EEz_
+EEzg
+EEzo
+EEzw
+EE~w
+EFzW
+EFz_
+EFzo
+EFzw
+EF~w
+EQhO
+EQig
+EQjO
+EQj_
+EQjg
+EQjo
+EQjw
+EQyw
+EQzO
+EQzW
+EQzg
+EQzo
+EQzw
+EQ~o
+EQ~w
+ETmw
+ETno
+ETnw
+ETzg
+ETzo
+ETzw
+ET~w
+EUZO
+EUZ_
+EUZo
+EUZw
+EUxo
+EUzW
+EUzo
+EUzw
+EU~w
+EV~w
+E]yw
+E]zg
+E]zo
+E]zw
+E]~o
+E]~w
+E^~w
+E~~w