Skip to content

Commit

Permalink
add function documentation to setup.py
Browse files Browse the repository at this point in the history
  • Loading branch information
toravest committed May 23, 2025
1 parent bf142cd commit 19fd744
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion src/my_package/setup.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
import os

def set_up_API():
'''
This function is getting input from the user for their API-information.
The function creates, and add the API_KEY and API_EMAIL. When everything is set,
the API is good, and can be used to retrive data in the notebooks.
'''

# Define the path to the .env file at the root of the project
env_filepath = os.path.join(os.path.dirname(__file__), "../../.env")

Expand All @@ -22,4 +28,7 @@ def set_up_API():
print("You can now run the notebooks, and get data!")

print("Add your info to OpenWeatherMap.com, and the function will create and add the info to env.")
set_up_API()
set_up_API()

# This prints the documentation for the functions written inside '''these'''
# print(set_up_API.__doc__)

0 comments on commit 19fd744

Please sign in to comment.