Skip to main content

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


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.0.2.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

surgen-0.0.2-py2.py3-none-any.whl (6.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file surgen-0.0.2.tar.gz.

File metadata

  • Download URL: surgen-0.0.2.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for surgen-0.0.2.tar.gz
Algorithm Hash digest
SHA256 5911110c479880e4100c063eb9cc2e17632a56b88b4053ac9ca2b9e00b321c7e
MD5 86f11805af389d35e345c7d398eb2735
BLAKE2b-256 60cafbb063f47c4d3d0cd8833d656e1b8a7b2005e9ccd1c8745a00178eec60f5

See more details on using hashes here.

Provenance

File details

Details for the file surgen-0.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for surgen-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 78a526039efb547811508b6fbc201a79ca1c30ed64d3617aa6cbd569c169b65b
MD5 2bef750e419b273a32ad88030ba9a900
BLAKE2b-256 ccf74d6236cb2df624cc53d2f9f0ef4b13fa38434554ea6882e0bca72451f23f

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page