Pycrastinate
TODO less, DO more: Keep your code clean without changing the way you code.
Tired of TODO from people who have not touched that code in years? What about FIXME?
Pycrastinate is a language-agnostic tool that helps you keep your codebase (whether it is legacy or new) under control in a transparent way.
Usage
Try it out
It simply works out of the box! If you want to run it within another python script do the following:
from pycrastinate import pycrastinate
pycrastinate(“full_path_to_your_config_file/config_name.py”)
If you want to run it as a command line tool just run python pycrastinate.py path_to_your_config/config.py inside its root directory and experience the magic. You can get sample config.py and config_not_git.py files from https://github.com/isaacbernat/pycrastinate
Dive in
Pycrastinate was featured in a 25-minute talk in PyCon Sweden 2014. There you can find the PDF and the original version http://2014.pycon.se/ . The slides include real life use-case examples.
Tune it
Create your own config file. Change the root_paths for whichever paths hold the files you want to analyse, the file_sufixes to include only those that you want (e.g. only python files), the tokens that should be considered (e.g. TODO), their case-sensitivity, etc. and then store it on the root path for pycrastinate. The config name must not have any “.” besides de final “.py” and you can use it by running python pycrastinate.py your_config_name
Master it
It is highly encouraged to read at least the succint github documentation and check the slides from PyCon Sweden 2014 if you plan to use pycrastinate seriously.
For more documentation see the homepage.
1 maintainer
Release files for pycrastinate 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pycrastinate-0.1.0.tar.gz | 5.7 kB | Details |
Release files / pycrastinate-0.1.0.tar.gz
| Download URL | pycrastinate-0.1.0.tar.gz |
|---|---|
| Size | 5.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
067d0ff17252d527a50689405dbf1ba96380ef174e7ba2e05dc065fc8bbec0e0
|
|
BLAKE2b-256 checksum How to use checksums |
3edfc9c62c9aecb23824576ac46d996c2f1f5996c1ba6efa9ce4f844e21ed76e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
