Submission of Team 3 #2
Conversation
|
this is good overall |
|
are you guys planning to address any of the above? |
|
as is, i tentatively grade this at 85% |
|
. |
README.md
Outdated
|
|
||
| ## 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. |
There was a problem hiding this comment.
that's not what the project is... it is an AI assistant, right?
There was a problem hiding this comment.
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?
| Use `ruff` to run static analysis (linting) on your code: | ||
| ```bash | ||
| ruff check . |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
can you enable all the checks and then tell me which ones are too pesky and you felt like you wanted to disable?
There was a problem hiding this comment.
I have enabled all the checks.
| To perform static type checking using `mypy`, run: | ||
| ```bash | ||
| mypy . |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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..,.
There was a problem hiding this comment.
I have made made the changes to python version and have changed to enable all the checks
README.md
Outdated
| name: Install dependencies | ||
| command: | | ||
| pip install pytest ruff mypy |
There was a problem hiding this comment.
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
| 1. **Missing Dependencies**: If any dependency-related issues arise, ensure all dependencies are installed by running: | ||
| ```bash | ||
| pip install -r requirements.txt |
There was a problem hiding this comment.
this is better!
why mention the packages up there literally?
There was a problem hiding this comment.
I will remove the mention of packages from there
mypy.ini
Outdated
| @@ -0,0 +1,3 @@ | |||
| [mypy] | |||
| python_version = 3.8 | |||
There was a problem hiding this comment.
any reason we are not going with 3.12+?
There was a problem hiding this comment.
seems like you have 3.12 in your pyproject.toml
There was a problem hiding this comment.
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
.circleci/config.yml
Outdated
| - run: | ||
| name: Install dependencies | ||
| command: | | ||
| pip install pytest ruff mypy |
There was a problem hiding this comment.
might have missed it. we will rectify it.
README.md
Outdated
|
|
||
| ## 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. |
| Use `ruff` to run static analysis (linting) on your code: | ||
| ```bash | ||
| ruff check . |
There was a problem hiding this comment.
can you enable all the checks and then tell me which ones are too pesky and you felt like you wanted to disable?
| To perform static type checking using `mypy`, run: | ||
| ```bash | ||
| mypy . |
There was a problem hiding this comment.
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..,.
|
lets make sure we have |
Alex-Ying
force-pushed
the
submission-team3
branch
from
0b7285f to
8f62c11
Compare
Teammates:
Siddharth Singh - [email protected]
Adittya Mittal - [email protected]
Anushka Tawte - [email protected]
Rafael de Leon - [email protected]
Alex Ying - [email protected]
Mridul Mittal - [email protected]