# norminette for 42 schools
## Install
Requires python3.8+ (3.8, 3.9, 3.10, 3.11)
### Directly inside your global commands
Install using pip.
```shell
python3 -m pip install --upgrade pip setuptools
python3 -m pip install norminette
```
To upgrade an existing install, use
```shell
python3 -m pip install --upgrade norminette
```
## Usage
- Runs on the current folder and any subfolder:
```
norminette
```
- Runs on the given filename(s):
```
norminette filename.[c/h]
```
- Prevents stopping on various blocking errors:
```
norminette -d
```
- Outputs all the debug logging:
```
norminette -dd
```
## Docker usage
```
docker build -t norminette .
cd ~/42/ft_printf
docker run -v $PWD:/code norminette /code
```
If you encounter an error or an incorrect output, you can:
- Open an issue on github
- Post a message on the dedicated slack channel (#norminette-v3-beta)
Please try to include as much information as possible (the file on which it crashed, etc)
Feel free to do pull requests if you want to help as well. Make sure that run_test.sh properly runs after your modifications.
## Run for development
This new version uses poetry as a dependency manager.
If you want to contribute:
```shell
poetry install
# Run dev norminette
poetry run norminette
# Or... with virtual env
source .venv/bin/activate
norminette
# Run tests
poetry run pytest
```
Raw data
{
"_id": null,
"home_page": "https://github.com/42School/norminette",
"name": "norminette",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0.0",
"maintainer_email": "",
"keywords": "42,norminette",
"author": "42",
"author_email": "pedago@42.fr",
"download_url": "https://files.pythonhosted.org/packages/32/7d/a7bd0a9eab47b0e23874996d62bc9af39328b7e9e939f29340330d56f4c5/norminette-3.3.55.tar.gz",
"platform": null,
"description": "# norminette for 42 schools\n\n## Install\n\nRequires python3.8+ (3.8, 3.9, 3.10, 3.11)\n\n### Directly inside your global commands\n\nInstall using pip.\n```shell\npython3 -m pip install --upgrade pip setuptools\npython3 -m pip install norminette\n```\n\nTo upgrade an existing install, use\n```shell\npython3 -m pip install --upgrade norminette\n```\n\n## Usage\n\n- Runs on the current folder and any subfolder:\n\n```\nnorminette\n```\n\n- Runs on the given filename(s):\n\n```\nnorminette filename.[c/h]\n```\n\n- Prevents stopping on various blocking errors:\n\n```\nnorminette -d\n```\n\n- Outputs all the debug logging:\n\n```\nnorminette -dd\n```\n\n## Docker usage\n\n```\ndocker build -t norminette .\ncd ~/42/ft_printf\ndocker run -v $PWD:/code norminette /code\n```\n\nIf you encounter an error or an incorrect output, you can:\n - Open an issue on github \n - Post a message on the dedicated slack channel (#norminette-v3-beta)\n \n\nPlease try to include as much information as possible (the file on which it crashed, etc)\n\nFeel free to do pull requests if you want to help as well. Make sure that run_test.sh properly runs after your modifications.\n\n## Run for development\n\nThis new version uses poetry as a dependency manager.\n\nIf you want to contribute:\n\n```shell\npoetry install\n\n# Run dev norminette\npoetry run norminette\n\n# Or... with virtual env\nsource .venv/bin/activate\nnorminette\n\n# Run tests\npoetry run pytest\n```\n",
"bugtrack_url": null,
"license": "MIT Licence",
"summary": "Open source C files linter for 42 Network campuses",
"version": "3.3.55",
"project_urls": {
"Homepage": "https://github.com/42School/norminette",
"Repository": "https://github.com/42School/norminette"
},
"split_keywords": [
"42",
"norminette"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f83c668d4102d9b0d4d19e872f7e5b44bb7056ebb423a5dff142aaa71a508012",
"md5": "ed7a0a1c3d6146451c105d91d34c3f10",
"sha256": "df33d36860047c12e1a663497fa508999fb34e45ba4ccec3999edf35af114a11"
},
"downloads": -1,
"filename": "norminette-3.3.55-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ed7a0a1c3d6146451c105d91d34c3f10",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0.0",
"size": 77428,
"upload_time": "2023-11-29T10:02:53",
"upload_time_iso_8601": "2023-11-29T10:02:53.249073Z",
"url": "https://files.pythonhosted.org/packages/f8/3c/668d4102d9b0d4d19e872f7e5b44bb7056ebb423a5dff142aaa71a508012/norminette-3.3.55-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "327da7bd0a9eab47b0e23874996d62bc9af39328b7e9e939f29340330d56f4c5",
"md5": "53c2c1552ad33e32f1e644f4d685c874",
"sha256": "66356de519fdd361043ea1473ea5317b6087ce60c9f1f2fb172aaf3f7fcfe98c"
},
"downloads": -1,
"filename": "norminette-3.3.55.tar.gz",
"has_sig": false,
"md5_digest": "53c2c1552ad33e32f1e644f4d685c874",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0.0",
"size": 46361,
"upload_time": "2023-11-29T10:02:54",
"upload_time_iso_8601": "2023-11-29T10:02:54.815650Z",
"url": "https://files.pythonhosted.org/packages/32/7d/a7bd0a9eab47b0e23874996d62bc9af39328b7e9e939f29340330d56f4c5/norminette-3.3.55.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-29 10:02:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "42School",
"github_project": "norminette",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "norminette"
}
JSON
