a utility library to help provide api route generation form function signature for web frameworks.
Project description
Surgen is a tool and library to help perform automated upgrades to codebases. It’s goals are:
- provide a simple CLI to facilitate upgrading codebases
- provide libraries to allow easy authoring of code migration scripts.
Installation
pip install surgen
Usage
Surgen is available as a command line tool, providing the directory containing surgen scripts, and the directory to apply them to:
surgen ./my_upgrade_scripts ./my_target_directory
Both arguments are optional, and default to the ./surgen-scripts directory and the current working directory, respectively.
Surgen Script
A surgen script MUST contain a class that:
- extends surgen.Procedure
- overrides operate(self)
- does NOT override __init__
A surgen script can:
- provide a should_run function to determine if the script should run (default true)
Examples of surgen scripts can be found in the examples/ directory.
TODO
- backup / restore
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
surgen-0.1.0.tar.gz
(8.7 kB
view hashes)
Built Distribution
surgen-0.1.0-py2.py3-none-any.whl
(12.9 kB
view hashes)
Close
Hashes for surgen-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04888368050286fa715e405ee53e185380646caae476c9315a300bdae9c42253 |
|
MD5 | 704e6c1c5bd46cc96eb38f7c27906687 |
|
BLAKE2-256 | a54d8e78f35aa045bc99a3b1f3fc44b3062610ed29d580b36d36d8236f91d40e |