Merge branch 'COG-685-more-document-types' of github.com:topoteretes/cognee into COG-685-more-document-types

CODE_OF_CONDUCT.md

@@ -0,0 +1,127 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement by emailing <NAME> at <EMAIL>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -49,10 +49,10 @@ python cognee/cognee/tests/test_library.py
 
 ```shell
 # Add your changes to the staging area:
-git add . 
+git add .
 
-# Commit changes with an adequate description: 
-git commit -m "Describe your changes here" 
+# Commit changes with an adequate description:
+git commit -m "Describe your changes here"
 
 # Push your feature branch to your forked repository:
 git push origin feature/your-feature-name
@@ -73,7 +73,7 @@ The project maintainers will review your work, possibly suggest improvements, or
 
 ## 5. 📜 Code of Conduct
 
-Ensure you adhere to the project's Code of Conduct throughout your participation.
+Ensure you adhere to the project's [Code of Conduct](https://github.com/topoteretes/cognee/blob/main/CODE_OF_CONDUCT.md) throughout your participation.
 
 ## 6. 📫 Contact
 

NOTICE.md

@@ -0,0 +1,10 @@
+topoteretes - cognee
+Copyright © 2024 Topoteretes UG. (haftungsbeschränkt), Schonehauser Allee 163, Berlin.
+
+This project includes software developed at Topoteretes UG. (https://www.cognee.ai/).
+
+<!-- Add software from external sources that you used here. e.g.
+
+This project redistributes code originally from <website>.
+
+ -->

cognee/modules/pipelines/operations/run_tasks.py

@@ -1,10 +1,12 @@
-import json
 import inspect
+import json
 import logging
+
 from cognee.modules.settings import get_current_settings
-from cognee.shared.utils import send_telemetry
-from cognee.modules.users.models import User
 from cognee.modules.users.methods import get_default_user
+from cognee.modules.users.models import User
+from cognee.shared.utils import send_telemetry
+
 from ..tasks.Task import Task
 
 logger = logging.getLogger("run_tasks(tasks: [Task], data)")
@@ -160,21 +162,28 @@ async def run_tasks_base(tasks: list[Task], data = None, user: User = None):
             raise error
 
 async def run_tasks_with_telemetry(tasks: list[Task], data, pipeline_name: str):
-    user = await get_default_user()
 
+    config = get_current_settings()
+    
+    logger.debug("\nRunning pipeline with configuration:\n%s\n", json.dumps(config, indent = 1))
+    
+    user = await get_default_user()
+    
     try:
         logger.info("Pipeline run started: `%s`", pipeline_name)
-        send_telemetry("Pipeline Run Started", user.id, {
-            "pipeline_name": pipeline_name,
-        })
-
+        send_telemetry("Pipeline Run Started", 
+                       user.id, 
+                       additional_properties = {"pipeline_name": pipeline_name, } | config
+                       )
+        
         async for result in run_tasks_base(tasks, data, user):
             yield result
 
         logger.info("Pipeline run completed: `%s`", pipeline_name)
-        send_telemetry("Pipeline Run Completed", user.id, {
-            "pipeline_name": pipeline_name,
-        })
+        send_telemetry("Pipeline Run Completed", 
+                       user.id, 
+                       additional_properties = {"pipeline_name": pipeline_name, }
+                       )
     except Exception as error:
         logger.error(
             "Pipeline run errored: `%s`\n%s\n",
@@ -182,15 +191,14 @@ async def run_tasks_with_telemetry(tasks: list[Task], data, pipeline_name: str):
             str(error),
             exc_info = True,
         )
-        send_telemetry("Pipeline Run Errored", user.id, {
-            "pipeline_name": pipeline_name,
-        })
+        send_telemetry("Pipeline Run Errored", 
+                       user.id, 
+                       additional_properties = {"pipeline_name": pipeline_name, } | config
+                       )
 
         raise error
 
 async def run_tasks(tasks: list[Task], data = None, pipeline_name: str = "default_pipeline"):
-    config = get_current_settings()
-    logger.debug("\nRunning pipeline with configuration:\n%s\n", json.dumps(config, indent = 1))
-
+    
     async for result in run_tasks_with_telemetry(tasks, data, pipeline_name):
         yield result

licenses/README.md

@@ -0,0 +1,4 @@
+# Third party licenses
+
+This folder contains the licenses of third-party open-source software that has been redistributed in this project.
+Details of included files and modifications can be found in [NOTICE](/NOTICE.md).