Yake Refactored .2 #91
Conversation
Teste de linting nos ficheiros atuais do yake
testes gerais
refatorização inicial do programa principal
criado workflow para verificar resultados
atualização resultados.yml
atualizado resultados.yml
atualizado status adicionados ficheiros originais para comparações
Removidos ficheiros originais, pois estavam a interferir com o score do teste pylint
highligths.py 90%
só falta refatorar variáveis, reconstruir métodos e documentação
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the YAKE repository by removing outdated Dockerfiles and demo files, updating documentation, and enhancing the CI/CD pipelines. Key changes include:
- Removal of legacy Dockerfiles, REST API implementation, and demo files.
- Updated README with improved installation and usage instructions.
- Revamped Makefile and GitHub workflows to use the new "uv" command and updated Python 3.10 settings.
Reviewed Changes
Copilot reviewed 155 out of 155 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docker/Dockerfiles/yake/Dockerfile | Removed outdated Dockerfile for YAKE. |
| docker/Dockerfiles/yake-server/yake-rest-api.py | Removed deprecated REST API implementation. |
| docker/Dockerfiles/yake-server/Dockerfile | Removed legacy Dockerfile for the YAKE server. |
| demo/streamlit_app.py | Removed the demo Streamlit App. |
| demo/packages.txt | Removed obsolete package dependency file. |
| README.md | Updated documentation, installation instructions, and usage examples. |
| Makefile | Added new commands using "uv" for installation, testing, and formatting. |
| .python-version | Updated Python version to 3.10. |
| .github/workflows/* | Introduced and updated CI/CD workflows for testing, linting, deployment, etc. |
| --help Show this message and exit. | ||
| ``` | ||
| Dont know which Deduplication function to use, see more [here](https://tiagolv.github.io/yakerf/docs/-getting-started#keyword-deduplication-methods) |
There was a problem hiding this comment.
[nitpick] There is a minor grammatical issue with 'Dont' which should be 'Don't'.
| Dont know which Deduplication function to use, see more [here](https://tiagolv.github.io/yakerf/docs/-getting-started#keyword-deduplication-methods) | |
| Don't know which Deduplication function to use, see more [here](https://tiagolv.github.io/yakerf/docs/-getting-started#keyword-deduplication-methods) |
| uv pip install git+https://github.com/LIAAD/yake | ||
| ``` | ||
| *Example text from Wikipedia* | ||
|
|
||
| <a name="rest-api-image"></a> | ||
| ### Option 2. REST API Server in a Docker container | ||
|
|
||
| This install will provide you a mirror of the original REST API of YAKE! available [here](https://boiling-castle-88317.herokuapp.com). | ||
| or | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
[nitpick] Consider using a consistent installation command format throughout the documentation to avoid confusion between using the git URL and the package name directly.
| name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@master |
There was a problem hiding this comment.
[nitpick] Using 'actions/checkout@master' is outdated; consider upgrading to a stable version tag (e.g., v4) for improved consistency and reliability.
| - uses: actions/checkout@master | |
| - uses: actions/checkout@v4 |
| on: | ||
| push: | ||
| branches: | ||
| - core-seperation # ou master, dependendo da sua branch principal |
There was a problem hiding this comment.
[nitpick] Ensure that the branch naming is consistent across all workflows to avoid deployment confusion—consider aligning this with the main branch used in other workflows (e.g., 'master').
| - core-seperation # ou master, dependendo da sua branch principal | |
| - master |
1 participant
Refactored code, added documentation ,updated readme, better CI/CD pipelin, new webpage with documentation and new links