Best way to hide credentials when sharing code

Hi,

I share code with my students. Obviously, I do not want to share appkey and password. I keep my lseg-data.config.json file outside the git repository and add a path to it. Until now, I delete the link to my credentials manually from the code to not pollute it. Is there a better way to keep credential safe when sharing the code via git?

Thanks.

Find more posts tagged with

python

#technology

Accepted answers

All comments

Jirapongse

@tsart

Thank you for reaching out to us.

I assume that you are using the @#LSEG Data Library for Python.

You can use the EX‑4.01.01‑Sessions.ipynb notebook to create a session with the specified credentials.

The example also shows which variables to define for storing those credentials.



APP_KEY = 'YOUR APP KEY GOES HERE!'

RDP_LOGIN                   = 'YOUR RDP LOGIN OR MACHINE GOES HERE!'

RDP_PASSWORD                = 'YOUR RDP PASSWORD GOES HERE!'

However, you can define the credentials as OS environment variables and then retrieve them from your Python code.

For example:

import os

APP_KEY = os.getenv('APP_KEY_ENV_VAR')

RDP_LOGIN = os.getenv('DP_USERNAME_ENV_VAR')

RDP_PASSWORD = os.getenv('DP_PASSWORD_ENV_VAR')

wasin.w V3

Hello @tsart

Alternatively, you can store your credential in an environment ".env" file, put this .env file in .gitignore file (to not add it to the repository), and use the https://pypi.org/project/python-dotenv/ library to retrieve the credential on runtime without changing your OS environment variables.

Example: .env

APP_KEY=1234
RDP_USER=username
RDP_PASSWORD=password

Code:

import os
from dotenv import load_dotenv

load_dotenv()
appkey = os.getenv('APP_KEY')
username = os.getenv('RDP_USER')
password = os.getenv('RDP_PASSWORD')

Note: If you have the OS environment variables the same name as on .env, the code gets the OS value first.

To let your students create their own .env file, you can create a file name ".env.example" and push it in your project repo with the following content. Then tell them to create their .env based on the .env.example file format.

.env.example

APP_KEY=<Your AppKey>
RDP_USER=<Your RDP Username>
RDP_PASSWORD=<Your RDP Password>

EXPLORE OUR SITES