Welcome to the team!
- Download Miniconda for Python 3.11 from the official website.
- Install Miniconda following the instructions for your operating system.
- Open a new terminal or command prompt to ensure the installation is recognized.
conda create -n ibm-watson python=3.11
conda activate ibm-watson
pip install -r requirements.txt
Create a .env
file in your project root based on the provided .env.example
:
WATSONX_API_KEY=your_api_key_here
WATSONX_PROJECT_ID=your_project_id_here
Replace your_api_key_here
and your_project_id_here
with the values you obtained from IBM Cloud and Watson.
python api-test.py
You should now be able to interact with the Watsonx AI through the command line interface.
To ensure smooth collaboration during the hackathon, please follow these guidelines:
Before making any changes:
git checkout main
git pull origin main
git checkout -b your-feature-name
Replace your-feature-name
with a brief description of your feature or fix.
Implement your feature or fix in the new branch.
If you've added new dependencies or made significant changes:
-
Update
requirements.txt
:pip freeze > requirements.txt
-
Update this README if necessary, especially if you've added new setup steps or changed existing ones.
git add .
git commit -m "Brief description of your changes"
git push origin your-feature-name
- Go to the project's GitHub page.
- Click on "Pull requests" and then "New pull request".
- Select your branch to compare with main.
- Fill in the PR template with details about your changes.
- Submit the PR for review.
If your teammates or mentors suggest changes, make them in your branch and push again. The PR will update automatically.
Once approved, merge your PR into the main branch.
Our discord #dev channel will be updating with changes.
Remember: Frequent communication with your team is key to a successful hackathon!
If you encounter any issues:
- Ensure your
.env
file is correctly set up with valid credentials. - Check your internet connection.
- Verify that you have the latest version of the required packages by running
pip install -r requirements.txt
again. - If you get API errors, check the IBM Cloud console for any service disruptions or quota limits.
If you're still having trouble, don't hesitate to ask your teammates or mentors for help!