feat: Submission-1

.circleci/config.yml

@@ -0,0 +1,54 @@
+version: 2.1
+
+executors:
+  my-docker-executor:
+    docker:
+      - image: cimg/python:3.11.10
+
+jobs:
+  build:
+    executor: my-docker-executor
+    steps:
+      - checkout
+
+      - run:
+          name: Get uv via curl and install it
+          command: |
+            curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - persist_to_workspace:
+          root: /home/circleci/
+          paths:
+            - .cargo
+
+  test:
+    executor: my-docker-executor
+    steps:
+      - checkout
+
+      - attach_workspace:
+          at: /home/circleci/
+
+      - run:
+          name: Set-up dependencies path
+          command: echo 'export PATH=$HOME/.cargo/bin:$PATH' >> $BASH_ENV
+
+      - run:
+          name: Set-up project dependencies
+          command: uv sync
+
+      - run:
+          name: Format python files with ruff
+          command: uv run ruff check . --fix
+
+      - run:
+          name: Run test files
+          command: uv run pytest
+
+workflows:
+  build_and_test:
+    jobs:
+      - build
+      - test:
+          requires:
+            - build

.gitignore

@@ -1,162 +1 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$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
-
-# 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
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
-.pdm.toml
-.pdm-python
-.pdm-build/
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-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/
+**/**cache**/**

.python-version

@@ -0,0 +1 @@
+3.11

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Kamen Yotov
+Copyright (c) 2024 Satyam Chatrola
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1 +1,47 @@
-# mAIgic-nyu
+# mAIgic
+This project will organize life by tracking messages and information that need follow-ups and reminding the user to take follow-ups. It will also provide a search based on individuals.
+
+The project aims to leverage AI to track and remind for follow up messages for systems like Slack, Trello, Whatsapp, Gmail, Google Docs comments, etc.
+
+# Technical tools
+- Programming Language: Python
+- Project dependency management tool: uv
+- Project linter: ruff
+- Project tester: pytest
+- Continuous Integration (CI) tool: circleCI
+
+# Instructions
+## Setup
+- Install `uv` on your system with command with `curl -LsSf https://astral.sh/uv/install.sh | sh`.
+- `cd` into the cloned repository and execute `uv sync` (This will install all the dependencies).
+- Activate the environment `venv` by executing `source ./.venv/bin/activate`.
+
+## Processes
+- To check the formatting standard with ruff (linter) execute either `uv run ruff check .` or `ruff check .` from the root directory of the project.
+- To test the code, execute either `uv run pytest .` or `pytest .` from the root directory of the project.
+
+Note: One can run tools like ruff and pytest independently or can run them through `uv`.
+
+## Commit Style Guide
+- Request to `strictly adhere` to the suggested commit style guide.
+- The project follows Udacity's [Commit Style Guide](https://udacity.github.io/git-styleguide/).
+- Reason:
+    - It is simple, elegant, concise and effective.
+    - It does not have many rules that could create confusion but yet have just enough to keep things working smoothly through clear and concise communication.
+
+## GitHub Workflow
+- Members of same team can preferably `clone` the repository.
+- Make sure to push new changes to `dev` remote branch.
+- Create a `Pull Request` and the changes would be reviewed and merged to the `main` remote branch. `Review` includes code, code quality, code standards, commit style guides, and Pull Request descriptions. Consistent code standards and documentation would be aided by `ruff`.
+- `main` branch serves as production branch which would accumulate new changes, features and bug-fixes from `dev` branch.
+- Would appreciate if you open `issues` whenever you come across any. Issues can be bugs, proposed features, performance / code improvement proposals, etc.
+
+## Requesting access to project and CI space
+- Send your`github username` to become collaborators to the project.
+- Send your `email id` used to `register with circleCI` to get access to the circleCI organization to manage CI workflows and triggers. You will receive an invitation in the provided email's inbox to join the circleCI organization.
+- Currently, the `magic2` CircleCI project is attached to this project.
+
+Note: Request to keep all `communication` in the Google Chats Project Group.
+
+# License
+mAIgic has a MIT-style license, as found in the [LICENSE](LICENSE) file.

pyproject.toml

@@ -0,0 +1,14 @@
+[project]
+name = "maigic"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "numpy>=2.1.1",
+    "pytest>=8.3.3",
+    "ruff>=0.6.5",
+]
+[tool.ruff.lint]
+select = ["ALL"]
+extend-ignore = ["S101", "D211", "D213"]

src/hello.py

@@ -0,0 +1,16 @@
+"""Dummy file to check ruff, pytest and automatic tests with CircleCI."""
+
+def addition(num1:int, num2:int) -> int:
+    """Add 2 numebrs and return their sum."""
+    return num1 + num2
+
+
+def main() -> int:
+    """Contain the main execution logic."""
+    n1 = 50
+    n2 = 49
+    return addition(n1, n2)
+
+
+if __name__ == "__main__":
+    main()

tests/__init__.py

@@ -0,0 +1 @@
+"""Make python identify tests directory as a refernciable package."""

tests/test_hello.py

@@ -0,0 +1,19 @@
+"""File tests hello.py file."""
+
+from src.hello import addition, main
+
+
+def test_addition() -> None:
+    """Test the addition function."""
+    test_7 = 7
+    test_0 = 0
+    test__2 = -2
+    assert addition(3, 4) == test_7
+    assert addition(-1, 1) == test_0
+    assert addition(-1, -1) == test__2
+
+
+def test_main() -> None:
+    """Test the main function's behavior."""
+    test_99 = 99
+    assert main() == test_99  # 50 + 49 = 99