Submission of Team 3 by isiddharthsingh · Pull Request #2 · nyuoss/mAIgic-nyu

isiddharthsingh · 2024-10-03T05:11:55Z

Teammates:
Siddharth Singh - sms10221@nyu.edu
Adittya Mittal - am14079@nyu.edu
Anushka Tawte - at5849@nyu.edu
Rafael de Leon - rdl404@nyu.edu
Alex Ying - aty2009@nyu.edu
Mridul Mittal - mm13171@nyu.edu

kyotov · 2024-10-06T12:58:04Z

this is good overall
i put some comments on -- please review and let me know when you have addressed them

kyotov · 2024-10-09T01:30:24Z

are you guys planning to address any of the above?

kyotov · 2024-10-09T01:31:31Z

as is, i tentatively grade this at 85%

kyotov · 2024-10-09T23:51:50Z

.

kyotov · 2024-10-06T12:52:46Z

+# mAIgic
+
+## Project Description
+**mAIgic** is a project focused on setting up testing, static analysis, and continuous integration (CI) using tools such as `pytest`, `ruff`, `mypy`, and CircleCI. It aims to automate quality checks, ensuring code correctness and adherence to best practices.


that's not what the project is... it is an AI assistant, right?

yes its an Ai assistant. for the start of the task we thought this is what we are doing and wrote the first readme and as we move ahead, we will make changes to the readme.

should we change it be an Ai Assistant?

yes, let's change it.

This has been changed.

kyotov · 2024-10-06T12:54:52Z

+### 2. Ruff (Linter)
+Use `ruff` to run static analysis (linting) on your code:
+```bash
+ruff check .


what checks are enabled?
can we make sure all checks are enabled?
discuss which checks you need to disable because they did not make sense.

select = ["E", "F", "W"]:
This is selecting the following categories of checks:
E: PEP 8 style errors (e.g., indentation, whitespace issues)
F: PyFlakes checks (e.g., undefined names, unused variables)
W: PEP 8 style warnings (e.g., line breaks around operators)

Do you want us to enable all the checks?

can you enable all the checks and then tell me which ones are too pesky and you felt like you wanted to disable?

I have enabled all the checks.

kyotov · 2024-10-06T12:54:56Z

+### 3. Mypy (Type Checking)
+To perform static type checking using `mypy`, run:
+```bash
+mypy .


what checks are enabled?
can we make sure all checks are enabled?
discuss which checks you need to disable because they did not make sense.

In our mypy.ini, these following checks are enabled:

python_version = 3.8: This specifies that mypy will assume your project is using Python 3.8. Any type hints or language features not supported by Python 3.8 will raise an error.

ignore_missing_imports = True: This setting tells mypy to ignore any missing type stubs (type information) for third-party libraries that do not have type hints. This prevents mypy from raising errors about missing types in libraries that aren’t type-annotated.

do you want us to include any specific checks?

i would lean towards enabling all available checks and then disabling ones that don't make sense.
let's also do latest version of python..,.

I have made made the changes to python version and have changed to enable all the checks

kyotov · 2024-10-06T12:55:36Z

+      - run:
+          name: Install dependencies
+          command: |
+            pip install pytest ruff mypy


same thing here -- it is not a great idea to repeat yourself.
otherwise when you add a new package you need you have to put it on multiple places

we will update this

this has been removed.

kyotov · 2024-10-06T12:56:08Z

+### Common Errors:
+1. **Missing Dependencies**: If any dependency-related issues arise, ensure all dependencies are installed by running:
+   ```bash
+   pip install -r requirements.txt


this is better!
why mention the packages up there literally?

I will remove the mention of packages from there

kyotov · 2024-10-06T12:56:37Z

@@ -0,0 +1,3 @@
+[mypy]
+python_version = 3.8


any reason we are not going with 3.12+?

seems like you have 3.12 in your pyproject.toml

no specific reason for the mypy file I found it from stack overflow and wrote that. we will make the changes to use the correct python version

kyotov · 2024-10-09T01:30:48Z

+      - run:
+          name: Install dependencies
+          command: |
+            pip install pytest ruff mypy


did you decide against uv?

might have missed it. we will rectify it.

this has been changed.

kyotov

please address all comments and let me know when you are ready for me to take another look!

kyotov · 2024-10-30T01:22:06Z

+# mAIgic
+
+## Project Description
+**mAIgic** is a project focused on setting up testing, static analysis, and continuous integration (CI) using tools such as `pytest`, `ruff`, `mypy`, and CircleCI. It aims to automate quality checks, ensuring code correctness and adherence to best practices.


yes, let's change it.

kyotov · 2024-10-30T01:22:31Z

+### 2. Ruff (Linter)
+Use `ruff` to run static analysis (linting) on your code:
+```bash
+ruff check .


can you enable all the checks and then tell me which ones are too pesky and you felt like you wanted to disable?

kyotov · 2024-10-30T01:23:17Z

+### 3. Mypy (Type Checking)
+To perform static type checking using `mypy`, run:
+```bash
+mypy .


i would lean towards enabling all available checks and then disabling ones that don't make sense.
let's also do latest version of python..,.

kyotov · 2024-11-07T00:42:39Z

lets make sure we have src/maigic/... for the code so that the user can do from maigic.api import ...
also add api.py

Added my submission files

0882633

kyotov closed this Oct 9, 2024

kyotov reopened this Oct 9, 2024

kyotov self-assigned this Oct 9, 2024

kyotov requested changes Oct 9, 2024

View reviewed changes

kyotov requested changes Oct 30, 2024

View reviewed changes

Alex-Ying added 2 commits November 17, 2024 22:36

Updated with PR1 Comments

ceabb02

Updated with 2nd Round of Comments

8f62c11

Alex-Ying force-pushed the submission-team3 branch from 0b7285f to 8f62c11 Compare November 21, 2024 00:25

Uh oh!

Conversation

isiddharthsingh commented Oct 3, 2024

Uh oh!

kyotov commented Oct 6, 2024

Uh oh!

kyotov commented Oct 9, 2024

Uh oh!

kyotov commented Oct 9, 2024

Uh oh!

kyotov commented Oct 9, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kyotov left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kyotov commented Nov 7, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants