Metadata-Version: 2.4
Name: skadd
Version: 1.0.3
Summary: User [with Setup Key] Creating Tool
Home-page: https://github.com/asinerum/skadd
Author: Asinerum Conlang Project
Author-email: asinerum.com@gmail.com
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: python-dotenv>=1.2.1
Requires-Dist: python-multipart>=0.0.29
Requires-Dist: starlette>=0.50.0
Requires-Dist: uvicorn>=0.38.0
Requires-Dist: jinja2>=3.1.6
Requires-Dist: tagrepo>=1.0.6
Requires-Dist: tier2>=1.0.10
Requires-Dist: pavro>=1.0.5
Requires-Dist: skgen>=1.0.3
Requires-Dist: uvia>=1.0.2
Requires-Dist: vapp>=1.0.4
Dynamic: license-file

# User [with Setup Key] Creating Tool

## Purpose
- This tiny tool (working as a web daemon) helps people to manage their small community of users.  
- The users are created manually by an administrator, and about to receive emails with their secret setup keys which can be added to modern authenticator apps.  
- After being created, a new user can log in the community portal with TOTP authenticator code.  
- The tool includes: user listing, creating, deleting routines. The user-creating routine allows administrators add new user name and email, then automatically send notification email.  
- The automatic email sending uses Google mail API under administrators Gmail account.  

## Installation
```bash
pip install uvia vapp skadd
```

## Sample Usage
```bash
## nano skadd.sh
export JWT_SECRET="very-strong-password"
export SETUPKEY_ENCRYPT_SECRET="other-strong-password"
export TOKEN_EXPIRE_MINUTES=30
export ADMIN_AUTHENTICATOR_EMAIL_LIST="EMAIL_LIST_SEPARATED_BY_COMMA"
export SENDER_GMAIL_ADDRESS="YOUR_WORKING_GMAIL_ADDRESS"
export SENDER_GMAIL_APP_PWD="YOUR_WORKING_GMAIL_APP_PWD"
export FILE_AVRO_AUTHORS="./users/roleauthors.avro"
export FILE_AVRO_DATA="./users/setupkeys.avro"
uvia -a vapp -m skadd [-p <PORT> [-H <HOST>]]
## The <PORT> is 21058 by default, but can be edited
## The <HOST> should be 127.0.0.1 for security reason
## chmod +x skadd.sh
## ./skadd.sh
```

Detailed tips, tricks, and examples, can be found at project's repository
https://github.com/asinerum/skadd

(C) 2026 Asinerum Conlang Project
