2023-12-09 03:34:44 +03:00
|
|
|
# Project Configuration Stuff
|
|
|
|
## Enforcing Configuration
|
2023-12-09 03:30:29 +03:00
|
|
|
|
2023-12-09 03:34:44 +03:00
|
|
|
Enforcing is done with the help of nitpick — a command-line tool.
|
2023-12-09 03:30:29 +03:00
|
|
|
|
|
|
|
### Installation
|
|
|
|
|
2022-10-24 00:02:42 +03:00
|
|
|
Install nitpick:
|
2021-10-11 14:48:26 +03:00
|
|
|
|
2023-12-09 03:30:29 +03:00
|
|
|
```sh
|
|
|
|
pipx install nitpick
|
|
|
|
```
|
|
|
|
|
|
|
|
### Usage
|
|
|
|
|
2022-10-24 00:02:42 +03:00
|
|
|
To check for errors only:
|
2023-12-09 03:30:29 +03:00
|
|
|
|
|
|
|
```sh
|
2023-12-09 03:34:44 +03:00
|
|
|
nitpick check
|
2023-12-09 03:30:29 +03:00
|
|
|
```
|
2022-10-24 00:02:42 +03:00
|
|
|
|
|
|
|
To fix and modify your files directly:
|
2023-12-09 03:34:44 +03:00
|
|
|
```sh
|
|
|
|
nitpick fix
|
|
|
|
```
|
2023-12-09 03:30:29 +03:00
|
|
|
|
2023-12-09 03:34:44 +03:00
|
|
|
## Initializing a Project
|
2023-12-09 03:30:29 +03:00
|
|
|
### Python
|
|
|
|
|
|
|
|
```sh
|
|
|
|
cookiecutter https://gitea.radium.group/radium/project-configuration.git --directory cookiecutter-python
|
|
|
|
```
|