https://github.com/alvarogarcia7/similar-buffers
https://github.com/alvarogarcia7/similar-buffers
github-actions library makefiles pre-commit python-3-12 tool
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/alvarogarcia7/similar-buffers
- Owner: alvarogarcia7
- License: mit
- Created: 2024-09-06T20:20:11.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-09T07:12:07.000Z (about 1 year ago)
- Last Synced: 2025-01-29T04:42:58.826Z (10 months ago)
- Topics: github-actions, library, makefiles, pre-commit, python-3-12, tool
- Language: Python
- Homepage:
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Similar Buffers detector
This is a library to detect similarities between buffers.
Given two buffers, `a` and `b`, the library will return a list of statistics about the similarity between the two
buffers.
## Design
The library is designed to be modular and extensible (following the OCP). The main components are:
* `Statistic`: A statistic is the interface that receives two buffers and computes a single statistic
* `SimilarBufferDetector`: The main class that receives a list of statistics. It is modeled as a Rules Engine.
# Running it
## Getting started - Local python
```bash
make virtualenvironment
source venv/bin/activate
make virtualenvironment-finish
make install
make test
```
## Getting started - Docker
```bash
make up
make bash
# continue the steps for the local installation
make down
```