Skip to main content

settings should be simple, boring and forget-able. With settipy it will be just that.

Project description

settipy

settings should be simple, and with settipy it is.

settings parses command line and environment variables on one line. And makes it available throughout the code base. Making using settings in your project as boring and unimportant as it should be. settings vars is as simple as:

settipy.set("FOO", "default value", "help text")

getting vars out has the same level of complexity as setting the value.

settipy["FOO"]

Features

  • Simple to use
  • supports command line and environment variables
  • Support for types: str, int, bool, list, dict
  • Singleton, makes it easy to use in program anywhere in the code-base
  • Supports help text with --help
  • Ease of use in any environment examples: linux, docker, k8
  • Force program to be run with env or cli vars.

Example

example of how to use. More can be found in the example_project

settipy.set("FOO", "default value", "handy help text")

settipy.parse()

print("foo = ", settipy["FOO"])

The above go will produce program that can be used as follows. get handy help text set in the above example on the same line. This can get very handy when the project grows and is used in different environments

$ python example.py --help
Usage of example.py:
  -FOO string
      handy help text (default "default value")

When no value is given, default value is used

$ python example.py
foo = default value

Running the binary with command line input

$ python example.py -FOO bar
foo = bar

Running the binary with environment variable

$ FOO=ok;python example.py
foo = ok

Order of preference

variables are set with preference variables on the command line will have highest preference. This because while testing you might want to override environment The priority order is as follows

  1. Command line input
  2. Environment variables
  3. Default values

Types

settipy supports different types. It's possible to use the method "get". But to be more clear to the reader of the code you can add the type e.g "get_bool".

// string
settipy.set("FOO", "default", "help text")
settipy["FOO"]

// integer
settipy.set_int("FOO", 42, "help text")
settipy["FOO"]

// boolean
settipy.set_bool("FOO", True, "help text")
settipy["FOO"]

// list
settipy.set_list("FOO", [1, 2, 3], "help text", sep=".")
settipy["FOO"]

dic = {
   "foo": ["bar",],
   "foo1": ["bar1", "bar2"]
}
settipy.set_dict("foodict", dic, "dict with lists", item_sep=";", key_sep=";", sep=",")
settipy["foodict"]

Var Should be set

settipy supports different types.

// string
settipy.set("foshure", True, "handy message", should=True)
flag: foshure handy message: should be set

Print vars before startup

Either run the program with --settipy-verbose as cli argument or settipy.parse(verbose=True)

Install

$ pip install settipy

Future features

  • Add support for passwords. Password can be stored as hashes. With salt and pepper. Pepper can be stored in envirnoment and the salt given at the cli. This will allow for safer storing of passwords. Passwords are then just hashes in config. At runtime at the parse fase settipy will use the salt and pepper to decrypt the password. Since this will properly use external package the major version upgrade is needed. 1.0 will be requirement free. and 2.0 will start to use packages.
  • Add Typing
  • Use logging

License

MIT

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

settipy-1.9.0.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

settipy-1.9.0-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file settipy-1.9.0.tar.gz.

File metadata

  • Download URL: settipy-1.9.0.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.10

File hashes

Hashes for settipy-1.9.0.tar.gz
Algorithm Hash digest
SHA256 02b418d743b835c4820731aa74c165e17757ac40ac46c6be41b11eadab68c151
MD5 42e9c027dd8a956bc59ddde07beddf16
BLAKE2b-256 80c60b7147913c2c1c7f57f1c6390dc0d93f83beddf4cf3f27606f8d7b2b33be

See more details on using hashes here.

File details

Details for the file settipy-1.9.0-py3-none-any.whl.

File metadata

  • Download URL: settipy-1.9.0-py3-none-any.whl
  • Upload date:
  • Size: 4.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.10

File hashes

Hashes for settipy-1.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 056dc3a699e4a85ffc3ea2e1fec67df0af86586b1df63464a62d9abdf6614a3c
MD5 2ce70a50b0dc0caa9e8f6a82070ae76c
BLAKE2b-256 0a7d3aa98fbba505add88171cd9e77770a8a98f94788c9f67d7fae75c7ff2b59

See more details on using hashes here.

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