diff --git a/semantic_match_registry/src/semantic_match_registry.egg-info/PKG-INFO b/semantic_match_registry/src/semantic_match_registry.egg-info/PKG-INFO deleted file mode 100644 index b932275..0000000 --- a/semantic_match_registry/src/semantic_match_registry.egg-info/PKG-INFO +++ /dev/null @@ -1,75 +0,0 @@ -Metadata-Version: 2.4 -Name: semantic_match_registry -Version: 0.1.0 -Summary: A prototype Semantic Match Registry implemented in Python -Author-email: Sebastian Heppner -Requires-Python: >=3.11 -Description-Content-Type: text/markdown -Requires-Dist: fastapi>=0.95.0 -Requires-Dist: pydantic>=1.10 -Requires-Dist: uvicorn>=0.21.1 -Requires-Dist: requests>=2.31.0 -Requires-Dist: networkx>=3.4.2 -Provides-Extra: dev -Requires-Dist: mypy; extra == "dev" -Requires-Dist: pycodestyle; extra == "dev" -Requires-Dist: coverage; extra == "dev" -Requires-Dist: types-networkx; extra == "dev" -Requires-Dist: types-requests; extra == "dev" - -# Semantic Match Registry - -This is a proof-of-concept implementation of a Semantic Match Registry (SMR) service using Python. -The idea behind this service is to create a uniform interface for exchanging semantic matches, that are stored -decentralized across multiple semantic matching services. - -> [!warning] -> This project is **not** about finding semantic matches or semantic similarities, it rather requires these as input. - -## Structure -The project is structured as follows: -- `algorithm.py` implements the decentralized match aggregation algorithm -- `service.py` offers the service implementation using the [FastAPI](https://fastapi.tiangolo.com/) framework. - Note that you can find a detailed interface description (OpenAPI) by [running](#how-to-use) the server locally and - navigating to `/docs`. - -## How to Use -There are two main options to run: - -### Run `service.py` -You need a working Python installation (3.11 or higher). -- Clone this repository -- Create a new virtual environment: `python3 -m venv venv` (Note that the service is only tested on Linux systems) -- Activate the virtual environment: `source venv/bin/activate` -- Install the package: `pip install .` -- Copy the `config.ini.default` to `config.ini` and adapt the fields as necessary -- Run the service: `python3 semantic_matcher/service.py` - -### Run via Docker -To run via docker, you obviously need a working docker installation. -- Clone the repository -- Copy the `config.ini.default` to `config.ini` and adapt the fields as necessary -- Choose one of the two options below: - -**Option 1:** Build and run manually - -In the project root directory: -```commandline -docker build -t semantic_match_registry . -``` -```commandline -docker run -d -p 8000:8000 semantic_match_registry -``` - -> [!note] -> You may have to change the port in the run command if you changed it in your `config.ini`. - -**Option 2:** Use the docker compose file - -In the project root directory: -```commandline -docker compose up -``` - -> [!note] -> If you changed your `config.ini`, you might need to adapt the respective fields in the `compose.yaml`. diff --git a/semantic_match_registry/src/semantic_match_registry.egg-info/SOURCES.txt b/semantic_match_registry/src/semantic_match_registry.egg-info/SOURCES.txt deleted file mode 100644 index b4d400b..0000000 --- a/semantic_match_registry/src/semantic_match_registry.egg-info/SOURCES.txt +++ /dev/null @@ -1,9 +0,0 @@ -README.md -pyproject.toml -src/semantic_match_registry.egg-info/PKG-INFO -src/semantic_match_registry.egg-info/SOURCES.txt -src/semantic_match_registry.egg-info/dependency_links.txt -src/semantic_match_registry.egg-info/requires.txt -src/semantic_match_registry.egg-info/top_level.txt -tests/test_algorithm.py -tests/test_semantic_matcher.py \ No newline at end of file diff --git a/semantic_match_registry/src/semantic_match_registry.egg-info/dependency_links.txt b/semantic_match_registry/src/semantic_match_registry.egg-info/dependency_links.txt deleted file mode 100644 index 8b13789..0000000 --- a/semantic_match_registry/src/semantic_match_registry.egg-info/dependency_links.txt +++ /dev/null @@ -1 +0,0 @@ - diff --git a/semantic_match_registry/src/semantic_match_registry.egg-info/requires.txt b/semantic_match_registry/src/semantic_match_registry.egg-info/requires.txt deleted file mode 100644 index 75e63d4..0000000 --- a/semantic_match_registry/src/semantic_match_registry.egg-info/requires.txt +++ /dev/null @@ -1,12 +0,0 @@ -fastapi>=0.95.0 -pydantic>=1.10 -uvicorn>=0.21.1 -requests>=2.31.0 -networkx>=3.4.2 - -[dev] -mypy -pycodestyle -coverage -types-networkx -types-requests diff --git a/semantic_match_registry/src/semantic_match_registry.egg-info/top_level.txt b/semantic_match_registry/src/semantic_match_registry.egg-info/top_level.txt deleted file mode 100644 index 8b13789..0000000 --- a/semantic_match_registry/src/semantic_match_registry.egg-info/top_level.txt +++ /dev/null @@ -1 +0,0 @@ -