readme
This commit is contained in:
218
.gitignore
vendored
Normal file
218
.gitignore
vendored
Normal file
@@ -0,0 +1,218 @@
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[codz]
|
||||
*$py.class
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
wheels/
|
||||
share/python-wheels/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
MANIFEST
|
||||
|
||||
# PyInstaller
|
||||
# Usually these files are written by a python script from a template
|
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||
*.manifest
|
||||
*.spec
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.nox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*.cover
|
||||
*.py.cover
|
||||
.hypothesis/
|
||||
.pytest_cache/
|
||||
cover/
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
*.pot
|
||||
|
||||
# Django stuff:
|
||||
*.log
|
||||
local_settings.py
|
||||
db.sqlite3
|
||||
db.sqlite3-journal
|
||||
|
||||
# Flask stuff:
|
||||
instance/
|
||||
.webassets-cache
|
||||
|
||||
# Scrapy stuff:
|
||||
.scrapy
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
||||
# PyBuilder
|
||||
.pybuilder/
|
||||
target/
|
||||
|
||||
# Jupyter Notebook
|
||||
.ipynb_checkpoints
|
||||
|
||||
# IPython
|
||||
profile_default/
|
||||
ipython_config.py
|
||||
|
||||
# pyenv
|
||||
# For a library or package, you might want to ignore these files since the code is
|
||||
# intended to run in multiple environments; otherwise, check them in:
|
||||
# .python-version
|
||||
|
||||
# pipenv
|
||||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
||||
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
||||
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
||||
# install all needed dependencies.
|
||||
#Pipfile.lock
|
||||
|
||||
# UV
|
||||
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
||||
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
||||
# commonly ignored for libraries.
|
||||
#uv.lock
|
||||
|
||||
# poetry
|
||||
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
||||
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
||||
# commonly ignored for libraries.
|
||||
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
||||
#poetry.lock
|
||||
#poetry.toml
|
||||
|
||||
# pdm
|
||||
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
||||
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
||||
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
||||
#pdm.lock
|
||||
#pdm.toml
|
||||
.pdm-python
|
||||
.pdm-build/
|
||||
|
||||
# pixi
|
||||
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
||||
#pixi.lock
|
||||
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
||||
# in the .venv directory. It is recommended not to include this directory in version control.
|
||||
.pixi
|
||||
|
||||
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
||||
__pypackages__/
|
||||
|
||||
# Celery stuff
|
||||
celerybeat-schedule
|
||||
celerybeat.pid
|
||||
|
||||
# Redis
|
||||
*.rdb
|
||||
*.aof
|
||||
*.pid
|
||||
|
||||
# RabbitMQ
|
||||
mnesia/
|
||||
rabbitmq/
|
||||
rabbitmq-data/
|
||||
|
||||
# ActiveMQ
|
||||
activemq-data/
|
||||
|
||||
# SageMath parsed files
|
||||
*.sage.py
|
||||
|
||||
# Environments
|
||||
.env
|
||||
.envrc
|
||||
.venv
|
||||
.venv-*
|
||||
env/
|
||||
venv/
|
||||
venv-*/
|
||||
ENV/
|
||||
env.bak/
|
||||
venv.bak/
|
||||
|
||||
# Spyder project settings
|
||||
.spyderproject
|
||||
.spyproject
|
||||
|
||||
# Rope project settings
|
||||
.ropeproject
|
||||
|
||||
# mkdocs documentation
|
||||
/site
|
||||
|
||||
# mypy
|
||||
.mypy_cache/
|
||||
.dmypy.json
|
||||
dmypy.json
|
||||
|
||||
# Pyre type checker
|
||||
.pyre/
|
||||
|
||||
# pytype static type analyzer
|
||||
.pytype/
|
||||
|
||||
# Cython debug symbols
|
||||
cython_debug/
|
||||
|
||||
# PyCharm
|
||||
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
||||
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
||||
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
||||
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
||||
#.idea/
|
||||
|
||||
# Abstra
|
||||
# Abstra is an AI-powered process automation framework.
|
||||
# Ignore directories containing user credentials, local state, and settings.
|
||||
# Learn more at https://abstra.io/docs
|
||||
.abstra/
|
||||
|
||||
# Visual Studio Code
|
||||
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
||||
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
||||
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
||||
# you could uncomment the following to ignore the entire vscode folder
|
||||
# .vscode/
|
||||
|
||||
# Ruff stuff:
|
||||
.ruff_cache/
|
||||
|
||||
# PyPI configuration file
|
||||
.pypirc
|
||||
|
||||
# Marimo
|
||||
marimo/_static/
|
||||
marimo/_lsp/
|
||||
__marimo__/
|
||||
|
||||
# Streamlit
|
||||
.streamlit/secrets.toml
|
||||
76
README.md
Normal file
76
README.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# MayoStainHelper
|
||||
|
||||
## Opis Projektu
|
||||
|
||||
**MayoStainHelper** to aplikacja wspierająca rzemieślników zajmujących się nakładaniem bejcy na gitary. Głównym celem projektu jest eliminacja zawodności ludzkiego oka w ocenie subtelnych różnic kolorystycznych, co prowadzi do uzyskania perfekcyjnej powtarzalności barw. Dzięki temu rozwiązaniu nawet najbardziej skomplikowane i wieloetapowe procesy bejcowania stają się przewidywalne, a finalny produkt spełnia najwyższe standardy jakości.
|
||||
|
||||
Aplikacja jest zaprojektowana tak, aby była intuicyjna i prosta w obsłudze, nawet dla osób bez specjalistycznej wiedzy na temat fotografii czy przetwarzania obrazu.
|
||||
|
||||
---
|
||||
|
||||
## Kluczowe Funkcje
|
||||
|
||||
- **Podgląd na żywo z kamery**
|
||||
Aplikacja wyświetla obraz w czasie rzeczywistym z podłączonego aparatu, umożliwiając bieżące monitorowanie procesu nakładania koloru.
|
||||
|
||||
- **Porównanie w czasie rzeczywistym**
|
||||
Możliwość nałożenia obrazu referencyjnego na podgląd na żywo z kamery, co ułatwia natychmiastowe porównanie i weryfikację koloru.
|
||||
|
||||
- **Łatwa kalibracja kolorów**
|
||||
Użytkownik może w prosty sposób skalibrować obraz z aparatu oraz wyświetlany na ekranie, używając karty SpyderChecker 24. Zapewnia to, że kolory widziane w aplikacji są zawsze wiarygodne.
|
||||
|
||||
- **Wspomaganie ekspozycji**
|
||||
Aplikacja wyświetla histogram na bieżąco, pomagając użytkownikowi w optymalnym ustawieniu parametrów aparatu (ISO, przesłona, czas naświetlania).
|
||||
|
||||
- **Baza kolorów**
|
||||
Aplikacja przechowuje bazę referencyjnych zdjęć i filmów, zorganizowaną według modeli gitar. Pozwala to na szybki dostęp do odpowiednich wzorców.
|
||||
|
||||
- **Rejestrowanie mediów**
|
||||
Możliwość robienia zdjęć oraz nagrywania wideo, które można dodać do bazy kolorów. Jest to przydatne, gdy dany proces bejcowania wymaga uwiecznienia poszczególnych etapów.
|
||||
|
||||
---
|
||||
|
||||
## Wymagania Systemowe
|
||||
|
||||
Projekt jest pisany w języku Python i projektowany z myślą o kompatybilności z różnymi systemami operacyjnymi:
|
||||
|
||||
- **Systemy operacyjne:**
|
||||
macOS (docelowy), Windows, Linux
|
||||
|
||||
- **Sprzęt:**
|
||||
- Podłączony aparat cyfrowy, kompatybilny z biblioteką gphoto2 (np. Canon 550D)
|
||||
- Karta kalibracyjna SpyderChecker 24
|
||||
|
||||
---
|
||||
|
||||
## Technologia
|
||||
|
||||
Projekt wykorzystuje następujące biblioteki i technologie:
|
||||
|
||||
- **Python** – język programowania
|
||||
- **PySide6** – do tworzenia interfejsu graficznego (GUI)
|
||||
- **pygphoto2** (wymaga gphoto2) – do komunikacji z aparatem
|
||||
- **OpenCV** – do przetwarzania obrazu i kalibracji kolorów
|
||||
- **SQLite** – do zarządzania bazą danych kolorów
|
||||
- **Matplotlib & NumPy** – (potencjalnie) do analizy i wizualizacji danych
|
||||
|
||||
---
|
||||
|
||||
## Instalacja
|
||||
|
||||
> Szczegółowe instrukcje instalacji zostaną dodane w przyszłości. Przykładowe kroki:
|
||||
|
||||
1. Sklonuj repozytorium:
|
||||
`git clone https://github.com/twoja_nazwa_uzytkownika/MayoStainHelper.git`
|
||||
2. Przejdź do katalogu projektu:
|
||||
`cd MayoStainHelper`
|
||||
3. Zainstaluj zależności:
|
||||
`pip install -r requirements.txt`
|
||||
4. Uruchom aplikację:
|
||||
`python main.py`
|
||||
|
||||
---
|
||||
|
||||
## Licencja
|
||||
|
||||
Projekt jest prywatny i przeznaczony do użytku wewnętrznego firmy.
|
||||
Reference in New Issue
Block a user