Merge pull request #10 from dialogoo/docs/apache-license-update

chore: embrace open source - migrate to Apache 2.0

Author: OscarArroyoVega

CONTRIBUTING.md

@@ -5,23 +5,79 @@ Thanks for helping improve **laiive**!
 ---
 
 ## Agreement
-By cloning, forking, or making a pull request, you **accept** the [Collaborator Agreement](./LICENSES/COLLABORATOR_AGREEMENT.md).If you don’t agree, please don’t contribute.
+Take a look to the [Collaborator Agreement](./LICENSES/COLLABORATOR_AGREEMENT.md).
 
 ---
 
 ## How to Contribute
 - Open issues for bugs, ideas, or questions.
 - Make pull requests with clear, focused changes.
-- Keep commit messages simple and descriptive.
+- Follow our commit message guidelines below.
+
+---
+
+## Commit Message Guidelines
+
+We prioritize self-documenting code and meaningful commit messages. Code should clearly express **what** it does, while commit messages explain **why**.
+
+### Format
+
+```
+<type>: <brief summary>
+
+<detailed explanation>
+- Why was this change necessary?
+- What problem does it solve?
+- What alternatives were considered?
+```
+
+### Types
+- `feat:` New feature
+- `fix:` Bug fix
+- `refactor:` Code restructuring
+- `perf:` Performance improvement
+- `docs:` Documentation
+- `test:` Tests
+- `chore:` Maintenance
+
+### Example
+```
+refactor: Replace nested loops with hash map in findDuplicates
+
+The O(n²) approach was causing timeouts on large datasets.
+HashMap provides O(1) lookups and reduces execution time
+from 2.3s to 45ms on 10k items.
+
+Refs: #156
+```
+
+### Code Documentation Rules
+
+**Avoid:**
+- Comments restating obvious code
+- Commented-out code (use git history)
+- Vague TODOs and FIXMEs without context
+
+**Include:**
+- Why non-obvious decisions were made
+- Complex business logic explanations
+- Known limitations or edge cases
+- Public API documentation
+- Complex algorithms or patterns
 
 ---
 
 ## Respect & Kindness
 - Be kind and polite.
 - Listen to others and assume good intent.
 - Disagree with ideas, not with people.
-- No harassment, insults, or sharing private project info.
 
 ---
 
-That’s it. Let’s keep things simple, safe, and respectful while building together.
+That's it. Let's keep things simple, safe, and respectful while building together.
+
+---
+
+## Recomended reading to be a good contributor
+
+- Hunt, A., & Thomas, D. (2019). The pragmatic programmer: Your journey to mastery (20th anniversary ed.). Addison-Wesley.

LICENSES/CHANGE_LICENSE_DATE.txt

@@ -1,35 +1,24 @@
-#### Third-Party Licenses
+# Third-Party Licenses
 
-This project uses the following third-party libraries:
+This project includes and depends on the following open source libraries:
 
-- pre-commit-hooks (MIT License)
-  https://github.com/pre-commit/pre-commit-hooks
+## Development Tools
+- **pre-commit-hooks** (MIT) - https://github.com/pre-commit/pre-commit-hooks
+- **ruff-pre-commit** (MIT) - https://github.com/astral-sh/ruff-pre-commit
+- **mypy** (MIT) - https://github.com/python/mypy
+- **bandit** (Apache-2.0) - https://github.com/PyCQA/bandit
+- **detect-secrets** (Apache-2.0) - https://github.com/Yelp/detect-secrets
+- **sqlfluff** (MIT) - https://github.com/sqlfluff/sqlfluff
+- **commitizen** (MIT) - https://github.com/commitizen-tools/commitizen
 
-- ruff-pre-commit (MIT License)
-  https://github.com/astral-sh/ruff-pre-commit
+## Runtime Dependencies
+- **streamlit** (Apache-2.0) - https://github.com/streamlit/streamlit
+- **fastapi** (MIT) - https://github.com/tiangolo/fastapi
+- **pgvector** (PostgreSQL License) - https://github.com/ankane/pgvector
 
-- mypy (MIT License)
-  https://github.com/python/mypy
+[Add other runtime dependencies from your requirements.txt/pyproject.toml]
 
-- bandit (Apache-2.0 License)
-  https://github.com/PyCQA/bandit
+---
 
-- detect-secrets (Apache-2.0 License)
-  https://github.com/Yelp/detect-secrets
-
-- sqlfluff (MIT License)
-  https://github.com/sqlfluff/sqlfluff
-
-- commitizen (MIT License)
-  https://github.com/commitizen-tools/commitizen
-
-- streamlit (Apache-2.0 License)
-  https://github.com/streamlit/streamlit
-
-- fastapi (MIT License)
-  https://github.com/tiangolo/fastapi
-
-- pgvector (PostgreSQL License)
-  https://github.com/ankane/pgvector
-
-Each third-party library is subject to its own license, which is included here for reference.
+All third-party software is used in compliance with their respective licenses.
+Full license texts are available in the linked repositories.

LICENSES/LICENSE_PRECHANGE.txt

@@ -52,9 +52,15 @@ A Postgres db is the heart of this dynamics and stores all the system knowledge.
 
 ---
 
-[^*]: © laiive. All strategic documents, diagrams, mockups, and planning materials contained in this repository are the intellectual property of Laiive and are provided solely for reference purposes. Unauthorized reproduction, distribution, reverse engineering, or commercial use of these materials is strictly prohibited without prior written consent from Laiive. For questions regarding usage rights or licensing, please contact: [email protected].
+[^*]: © 2025 Oscar Arroyo Vega. This project is licensed under the Apache License 2.0. You are free to use, modify, and distribute this software for any purpose, including commercial use, under the terms of the Apache 2.0 License. See the LICENSE file for details.
 
+## License
 
+This project is licensed under the **Apache License 2.0** - see the [LICENSE](LICENSES/LICENSE) file for details.
+
+Copyright 2025 Oscar Arroyo Vega
+
+---
 
 ### instructions
 

LICENSES/THIRD_PARTY_LICENSES.md

@@ -1,16 +1,13 @@
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
 
-# services/scraper/db_parser/config.py
 
 from pydantic import BaseSettings
 
 class DbParserSettings(BaseSettings):
-    # … (other settings fields)
+    # TODO
 
-# … (any other module‐level code)
 
-# Replace instantiation to match the new class name
 settings = DbParserSettings()
     POSTGRES_URL: str
 
@@ -32,7 +29,7 @@ class db_parser_settings(BaseSettings):
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
-        # Fix the URL format for psycopg2
+        # FIXME the URL format for psycopg2
         if self.POSTGRES_URL.startswith("postgresql+asyncpg://"):
             self.POSTGRES_URL = self.POSTGRES_URL.replace(
                 "postgresql+asyncpg://", "postgresql://"

README.md

@@ -17,13 +17,10 @@ def __init__(self, database_url: str = None):
         self.PERFECT_SIMILARITY_THRESHOLD = 1.0
 
     def get_connection(self):
-        """Get database connection"""
         return psycopg2.connect(self.database_url)
 
     def insert_events(self, events_data, source_website="www.ecodibergamo.it"):
-        """Insert events with duplicate checking with perfect match and rapidfuzz similarity.
-        returns: inserted count"""
-        # TODO improve the insertion logic, check artist and date filtering by place.
+        # TODO improve the insertion logic, check artist and date filtering by place. add pydantic for type verification
 
         timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
         self.review_file = (
@@ -118,7 +115,6 @@ def insert_events(self, events_data, source_website="www.ecodibergamo.it"):
         return inserted_count
 
     def get_events_count(self) -> int:
-        """Get total number of events in database"""
         conn = self.get_connection()
         cursor = conn.cursor()
         cursor.execute("SELECT COUNT(*) FROM events")
@@ -134,7 +130,6 @@ def _log_for_review(
         similarity: float,
         event_data: dict = None,
     ):
-        """function to save the logs for review in case of insert duplicate doubt"""
 
         review_entry = {
             "timestamp": datetime.now().isoformat(),
@@ -162,7 +157,6 @@ def get_review_summary(
     ) -> Dict[
         str, Any
     ]:  # TODO add all the data for review and check reviews for artists and venues
-        """Get summary of items pending review"""
         try:
             with open(self.review_file, "r", encoding="utf-8") as f:
                 lines = f.readlines()
@@ -172,12 +166,11 @@ def get_review_summary(
                 if line.strip():
                     try:
                         entry = json.loads(line.strip())
-                        if entry.get("decision") is None:  # Not yet reviewed
+                        if entry.get("decision") is None:  # TODO Not yet reviewed
                             pending_reviews.append(entry)
                     except json.JSONDecodeError:
                         continue
 
-            # Group by table
             by_table = {}
             for review in pending_reviews:
                 table = review["table"]
@@ -196,21 +189,18 @@ def get_review_summary(
             return {"total_pending": 0, "by_table": {}, "pending_reviews": []}
 
     def remove_review_file(self):
-        """Clear the review file"""
         if os.path.exists(self.review_file):
             os.remove(self.review_file)
             logger.info("Cleared review file")
 
     def _normalize_text(self, text: str) -> str:
-        """Normalize text for comparison"""
         if not text:
             return ""
         normalized = re.sub(r"[^\w\s]", "", text.lower().strip())
         normalized = re.sub(r"\s+", " ", normalized)
         return normalized
 
     def _calculate_similarity(self, text1: str, text2: str) -> float:
-        """Calculate similarity between two texts"""
         if not text1 or not text2:
             return 0.0
         return fuzz.ratio(
@@ -220,10 +210,6 @@ def _calculate_similarity(self, text1: str, text2: str) -> float:
     def _find_duplicate_entity(
         self, cursor, table_name: str, name: str, entity_type: str = "entity"
     ) -> Optional[tuple]:
-        """this method is to find duplicates with exact match and with fuzzysearch
-        level one checks for exact match
-        second level check for rapidfuzz match
-        """
         if not name or not name.strip():
             return None
 
@@ -235,13 +221,12 @@ def _find_duplicate_entity(
                 f"{entity_type.title()} exact match found: '{name}' (ID: {exact_match[0]})"
             )
             return (exact_match[0], "exact", exact_match[1])
-        # Level 2: Similarity-based match (only if no exact matches found)
+
         self._find_similar_entity(cursor, table_name, name, entity_type)
 
     def _find_similar_entity(
         self, cursor, table_name: str, name: str, entity_type: str
     ) -> Optional[tuple]:
-        """Find similar entities using similarity calculation"""
         cursor.execute(f"SELECT id, name FROM {table_name}")
         all_entities = cursor.fetchall()
 
@@ -268,7 +253,6 @@ def _find_similar_entity(
         return None
 
     def _is_duplicate_event(self, cursor, event) -> bool:
-        """Check if event is a duplicate using standardized 4-level detection"""
         event_name = event.get("name")
         if not event_name:
             return False

services/scraper/db_parser/__init__.py renamed to services/parser/__init__.py

@@ -5,8 +5,8 @@
 import sys
 import os
 
-sys.path.append(os.path.join(os.path.dirname(__file__), "..", ".."))
-from db_parser.parser import DatabaseParser
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+from parser.parser import DatabaseParser
 
 
 class EppenMusicSpider(scrapy.Spider):
@@ -223,7 +223,7 @@ def parse_to_db(self):
             self.logger.warning("No event data to parse")
             return
 
-        from db_parser.config import settings
+        from parser.config import settings
 
         db_parser = DatabaseParser(settings.POSTGRES_URL)
 

services/scraper/db_parser/config.py renamed to services/parser/config.py

@@ -8,8 +8,8 @@
 sys.path.insert(0, workspace_root)
 
 # Now import from services
-from services.scraper.db_parser.parser import DatabaseParser
-from services.scraper.db_parser.config import settings
+from services.parser.parser import DatabaseParser
+from services.parser.config import settings
 from loguru import logger