# Mikelint
Yet another attempt at a static analysis tool for CSSE1001.
## Prerequisite
You need Python 3.9 or above to run this project. Python 3.8 or below will not work.
## Setting up
1. Clone this repo `git clone https://github.com/mike-fam/mikelint.git`
2. cd into the repo and create a new virtual environment
```shell
cd mikelint
python3.9 -m venv venv && source venv/bin/activate
```
3. Install the required packages
```shell
pip install -r requirements.txt
```
## How to use the linter
1. Create a config YAML file, an example of a config file is at `config.example.yaml`.
The key-values of the YAML file go from Criteria > Sub-criteria > Analyser/checker.
2. Run `python run.py -c config.yaml -s some_file.py`, with `config.yaml` being your
configuration file and `some_file.py` being the file to run the analyser on.
## How to contribute
If you want to contribute, DM me on Facebook or email me at mikepham1207@gmail.com.
I'll give you editor access to the repo.
Then, clone this repo and make a new branch, and write your implementation on that
branch. Make a new pull request when you're ready. You'll be asked to go through a
checklist before opening the PR.
Once I approve the PR, you can merge it to the main branch.
Check out the documentation in the `docs` directory for more implementation details.
Raw data
{
"_id": null,
"home_page": "https://github.com/mike-fam/mikelint",
"name": "mikelint",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Mike Pham",
"author_email": "mikepham1207@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b1/45/140816acd0862b50801257fd89c350e556adc79e95c149e2f98056bb6653/mikelint-1.2.5.tar.gz",
"platform": null,
"description": "# Mikelint\nYet another attempt at a static analysis tool for CSSE1001.\n\n## Prerequisite\nYou need Python 3.9 or above to run this project. Python 3.8 or below will not work.\n\n## Setting up\n1. Clone this repo `git clone https://github.com/mike-fam/mikelint.git`\n2. cd into the repo and create a new virtual environment\n ```shell\n cd mikelint\n python3.9 -m venv venv && source venv/bin/activate\n ```\n3. Install the required packages\n ```shell\n pip install -r requirements.txt\n ```\n\n## How to use the linter\n1. Create a config YAML file, an example of a config file is at `config.example.yaml`. \n The key-values of the YAML file go from Criteria > Sub-criteria > Analyser/checker.\n \n2. Run `python run.py -c config.yaml -s some_file.py`, with `config.yaml` being your \n configuration file and `some_file.py` being the file to run the analyser on.\n \n## How to contribute\nIf you want to contribute, DM me on Facebook or email me at mikepham1207@gmail.com.\nI'll give you editor access to the repo.\n\nThen, clone this repo and make a new branch, and write your implementation on that \nbranch. Make a new pull request when you're ready. You'll be asked to go through a \nchecklist before opening the PR. \n\nOnce I approve the PR, you can merge it to the main branch.\n\nCheck out the documentation in the `docs` directory for more implementation details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Linter used for CSSE1001 at UQ",
"version": "1.2.5",
"project_urls": {
"Homepage": "https://github.com/mike-fam/mikelint"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "06894f82dd11bb1db47f4e6f47a108e310c3c1bebb5084d589530cf8641dbdea",
"md5": "3a149f9beac968fe92bcef30116ae88b",
"sha256": "0244a8926bc842c1315bd60a83af741f146772cc3349f4bf203e689e336c9fbf"
},
"downloads": -1,
"filename": "mikelint-1.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a149f9beac968fe92bcef30116ae88b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 17495,
"upload_time": "2023-10-30T12:11:36",
"upload_time_iso_8601": "2023-10-30T12:11:36.697445Z",
"url": "https://files.pythonhosted.org/packages/06/89/4f82dd11bb1db47f4e6f47a108e310c3c1bebb5084d589530cf8641dbdea/mikelint-1.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b145140816acd0862b50801257fd89c350e556adc79e95c149e2f98056bb6653",
"md5": "0235ae1f67f373fb56c87adbc3a26cb9",
"sha256": "fab72154f2860341e8dcdbdd9e70e81b02031fda397878f252e50f7a95d1bd43"
},
"downloads": -1,
"filename": "mikelint-1.2.5.tar.gz",
"has_sig": false,
"md5_digest": "0235ae1f67f373fb56c87adbc3a26cb9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 22588,
"upload_time": "2023-10-30T12:11:38",
"upload_time_iso_8601": "2023-10-30T12:11:38.138944Z",
"url": "https://files.pythonhosted.org/packages/b1/45/140816acd0862b50801257fd89c350e556adc79e95c149e2f98056bb6653/mikelint-1.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-30 12:11:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mike-fam",
"github_project": "mikelint",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "astroid",
"specs": [
[
"==",
"2.5.6"
]
]
},
{
"name": "isort",
"specs": [
[
"==",
"5.8.0"
]
]
},
{
"name": "lazy-object-proxy",
"specs": [
[
"==",
"1.6.0"
]
]
},
{
"name": "mccabe",
"specs": [
[
"==",
"0.6.1"
]
]
},
{
"name": "pylint",
"specs": [
[
"==",
"2.8.3"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"==",
"5.4.1"
]
]
},
{
"name": "toml",
"specs": [
[
"==",
"0.10.2"
]
]
},
{
"name": "wrapt",
"specs": [
[
"==",
"1.12.1"
]
]
}
],
"lcname": "mikelint"
}
JSON
