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"
20 Dec 16, 2022
912 Jan 05, 2023
6 Oct 09, 2022
1 Dec 15, 2021
4 Dec 23, 2021
6 Oct 02, 2022
1 Sep 03, 2022
8 Sep 22, 2022
1 Dec 01, 2021
195 Dec 13, 2022
5 May 19, 2022
3 Oct 28, 2022
37 Dec 18, 2022
15 Nov 27, 2022
1 Jan 22, 2022
3 Nov 03, 2021
1 Nov 23, 2021
7 Jan 07, 2023
3 Jun 15, 2021
45 Dec 19, 2022