You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://github.com/nuhmanpk/generate-api-key/actions/workflows/Pypi-uploads.yml)
@@ -48,26 +47,40 @@ from generateApiKey import generateApiKey
48
47
# Generating an API key
49
48
To generate an API key, you can use the generateApiKey() function and pass in the secret, seed, and an optional include keyword. For example:
| secret |`String`| Yes | "Topsecret" | The secret key used to generate the API key. It should be kept private and not shared with unauthorized parties. |
111
-
| seed |`String`| Yes | "12" | A value used to seed the generation of the API key. It can be any value, but it should be unique for each key. |
112
-
| include |`String`| Optional | "user1" | An optional value that can be included in the generated API key. It can be used to identify the user or application associated with the key. |
113
-
| add_dashes |`boolean`| Optional | True | A value used to determine wheather to add dashes or not in a key |
| secret |`String`| Yes | "Topsecret" | - | The secret key used to generate the API key. It should be kept private and not shared with unauthorized parties. |
124
+
| seed |`String`| Yes | "12" | - | A value used to seed the generation of the API key. It can be any value, but it should be unique for each key. |
125
+
| include |`String`| Optional | "user1" | - | An optional value that can be included in the generated API key. It can be used to identify the user or application associated with the key. |
126
+
| add_dashes |`boolean`| Optional | True | False | A value used to determine wheather to add dashes or not in a key |
127
+
| prefix |`String`| Optional | "hf" | None | A Value that is added infornt of the apikey generted to make your key unique for your platform |
114
128
115
129
116
130
By using this package, you are solely liable for any legal issues that may arise from its unauthorized use or misuse, as well as any security risks that may result from not properly securing the secret key used to generate the API keys.
@@ -121,4 +135,6 @@ This package is provided as is, without any warranties or guarantees of any kind
121
135
122
136
We encourage you to use the package responsibly, and to report any security issues or bugs you may encounter.
0 commit comments