Rubric
>> Automate the boilerplate while initializing your Python project <<
Preface
Rubric is an opinionated project initializer for Python. It assumes that you'll use:
- Black as the primary code formatter.
- Isort to sort the imports.
- Flake8 to ensure style guide conformance.
- Mypy to check the type hints.
- Pip-tools to manage the dependencies.
Following is a list of config files that Rubric is going to add to your directory:
root
├── .flake8 # Config file for .flake8
├── .gitignore # Python specific .gitignore file
├── makefile # Makefile containing the commands to lint your code
├── mypy.ini # Config file for mypy type checker
├── pyproject.toml # Toml file to hold a few common config vars
├── README.md # A readme boilerplate
├── requirements-dev.in # File to specify the top level dev requirements
├── requirements-dev.txt # File to specify the dev requirements
├── requirements.in # File to specify the top level app requirements
└── requirements.txt # File to specify the pinned app requirements
The files will contain minimal but sensible default configurations for the respective tools. You're free to change them as you like.
Installation
-
Rubric requires Python 3.7 and up.
-
Make a virtual environment in your project's root directory.
-
Activate the environment and run:
pip install rubric
Usage
-
To inspect all the CLI options, run:
rubric --helpYou should see the following output:
$ rubric ___ __ _ / _ \__ __/ / ____(_)___ / , _/ // / _ \/ __/ / __/ /_/|_|\_,_/_.__/_/ /_/\__/ usage: rubric [-h] [-l] [-d DIRNAME] [-o OVERWRITE [OVERWRITE ...]] [-v] [run] Rubric -- Initialize your Python project ⚙️ positional arguments: run run rubric & initialize the project scaffold optional arguments: -h, --help show this help message and exit -l, --list list the config files that are about to be generated -d DIRNAME, --dirname DIRNAME target directory name -o OVERWRITE [OVERWRITE ...], --overwrite OVERWRITE [OVERWRITE ...] overwrite existing config files, allowed values are: all, .flake8, .gitignore, README.md, makefile, mypy.ini, pyproject.toml, requirements-dev.in, requirements-dev.txt, requirements.in, requirements.txt -v, --version display the version number -
Initialize a project with the following command:
rubric runThis will run the tool in a non-destructive way—that means it won't overwrite any of the configuration files that you might have in the directory.
If you want to overwrite any of the existing config files that you might have in the directory, then run:
rubric run --overwrite filename1 filename2You can also point Rubric to a directory.
rubric run --directory "some/custom/directory"
4 Jun 05, 2022
0 Feb 07, 2022
134 Jul 29, 2022
1 Dec 05, 2021
47 Jan 03, 2023
1 Apr 08, 2022
3 Oct 27, 2022
2 Dec 05, 2021
63 Dec 05, 2022
1 Dec 05, 2021
6 May 16, 2022
1 Jul 09, 2021
336 Jan 02, 2023
30 Sep 13, 2022
62 Dec 14, 2022
0 Dec 27, 2021
3 Mar 24, 2022
3 May 27, 2022
11 Nov 21, 2022
33 Dec 14, 2022