Skip to main content

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
    cd mikelint
    python3.9 -m venv venv && source venv/bin/activate
    
  3. Install the required packages
    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.

Metadata

Release files for mikelint 1.2.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mikelint 1.2.6
File Size Uploaded Provenance Actions
mikelint-1.2.6.tar.gz 22.6 kB Without provenance Details for mikelint-1.2.6.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mikelint 1.2.6
File Interpreter ABI Platform Actions
mikelint-1.2.6-py3-none-any.whl Python 3 none any Details for mikelint-1.2.6-py3-none-any.whl

Total release size: 40.1 kB

Release files / mikelint-1.2.6.tar.gz

Download URL mikelint-1.2.6.tar.gz
Size 22.6 kB
Tags Source
SHA-256 checksum
How to use checksums
5f36c19bfc27e8ac38bf7f4cba1ccfd9b28b794d8ae0d3e1b967ffebe89341dd
BLAKE2b-256 checksum
How to use checksums
4f2beacb173d902fec41f63787c3f74a89625b8661f4c2be4cc60f3126cd97e6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.5

Release files / mikelint-1.2.6-py3-none-any.whl

Download URL mikelint-1.2.6-py3-none-any.whl
Size 17.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
541674cca119a7d8d780b39543123ee1d4f5083f77cda8893957af146838a9d4
BLAKE2b-256 checksum
How to use checksums
34f46c50c589628f86d7d2c738c41f0a8c8c5bb3b12969b7ca5acda20cdcc6e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.5

Security for mikelint 1.2.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page