stoken 0.2.2

A code desensitization tool, which can substitute tokens (and other sensitive information) in your code.

stoken

substitute-token

简体中文 | English docs

A code desensitization tool, which can substitute tokens (and other sensitive information) in your code.

---

Quick start

1. Run: pip install stoken

2. In the root directory of your project, create stoken.yaml and edit it with syntax of yaml.

   • suffix : the suffix of the files you want to detect. Don't forget there's a . before it.
   • token : the sensitive data you want to substitute.

suffix:
  - .py
  - .js
  	
token:
  SECRET_TOKEN: qwertyuiop123456789
  MY_PASSWORD: poiuytrewq987654321

3. Here is demonstration code file, with the suffix .py：

# demo.py
token = "qwertyuiop123456789"
password = "poiuytrewq987654321"
print(f"{token=}, {password=}")

4. Run stoken --mode hide, or run directly stoken with the default parameter --mode auto, the tokens will be substituted.

# demo.py
token = "#{{SECRET_TOKEN}}#"
password = "#{{MY_PASSWORD}}#"
print(f"{token=}, {password=}")

5. Run stoken --mode restore, or run directly stoken with the default parameter --mode auto, the tokens will be restored.

API

stoken --help

options	description
--mode	The mode of operation. Default: auto
-e | --encoding	The encoding used to decode the file. Default: utf-8
-p | --variable-prefix	The prefix of variable placeholder. Default: #{{
-s | --variable-suffix	The suffix of variable placeholder. Default: }}#
--debug	Activate this option to enter debug mode, as result, stoken won't modify files, only detect tokens.
--no-git	By default, the program will detect if there is a git directory, and if so, it will ignore the files in .gitignore. Activate this option to detect all the files.
--help	Show this message and exit.