Skip to main content

For everything that you really should not be hardcoding.

Project description

This package wants to replace your hardcoded.password, your hardcoded.api_key, actually hardcoded("Everything you really shouldn't be hardcoding").

To move a hardcoded value from your code to an external file, use hardcoded.foo as if it was holding your value already. On running the code, this will happen:

  • if an environment variable exist with exactly the same name ("foo" in our example), the value of that environment variable is returned
  • otherwise, hardcoded will find a file holding your data
    • if you initialised hardcoded as hardcoded.File(path='secrets.yml'), secrets.yml is used
    • if you are running code inside a git repository, .hardcoded.yml is used, at the root of the repository (next to .git/)
    • otherwise, ~/.config/hardcoded.yml is used
  • if the file is encrypted:
    • with GPG, then hardcoded interfaces with your GPG installation (possibly using the gpg-agent)
    • if symmetric encryption was used:
      • if a password was cached, it is used to decrypt the data
      • if Apple Keychain is available, a password is requested to decrypt the data
      • if running interactively, you will be asked for a decryption password
  • the (decrypted if needed) YAML data is loaded
  • if "foo" is a key in the YAML, the value of that key is returned
  • if "foo" does not exist in the YAML yet:
    • if not running interactively (stdin is not an open TTY), a KeyError is raised
    • if running interactively, you are asked to input the value
      • if encryption is requested with hardcoded.File(secret=True), the YAML is encrypted:
        • if GPG is available, the YAML is GPG encrypted with a key of your choosing
        • if Apple Keychain is available, a random password is generated and stored in the keychain
        • otherwise, you are asked for a new password
  • the value of foo is returned to your code

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

hardcoded-0.14.13.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hardcoded-0.14.13-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file hardcoded-0.14.13.tar.gz.

File metadata

  • Download URL: hardcoded-0.14.13.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.1.dev0+g94f810c.d20240510 CPython/3.12.3

File hashes

Hashes for hardcoded-0.14.13.tar.gz
Algorithm Hash digest
SHA256 8d4f80c0f01009bb3a85c98fa7c213aca5c85082bfe7b4b5bc9ec488f1994c25
MD5 81453b482ff95374fb70cfdb9a04147b
BLAKE2b-256 872cfc2fc3ca2631db70780bcfe2950b0df09669df0460001000d63b08a4ef42

See more details on using hashes here.

File details

Details for the file hardcoded-0.14.13-py3-none-any.whl.

File metadata

  • Download URL: hardcoded-0.14.13-py3-none-any.whl
  • Upload date:
  • Size: 11.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.1.dev0+g94f810c.d20240510 CPython/3.12.3

File hashes

Hashes for hardcoded-0.14.13-py3-none-any.whl
Algorithm Hash digest
SHA256 9d642dd9f529d0c91a32022102b6edff81caf4b640604445529a4b20bd00e6c1
MD5 0b7a0a0043ad565cecce82795fe11e23
BLAKE2b-256 9c0ae459bcbba6eb78e454fb08361653a984d1cb106d1db37cecfc1e37e73844

See more details on using hashes here.

Supported by

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