GitHub Introduction: Remote Repositories

Hands-on Practice: Working with GitHub

Let's practice the GitHub workflow with our Python Todo application from the previous session.

Exercise 1: Create a Remote Repository

1. Create a new repository on GitHub:
   • Name: "python_todo_app"
   • Description: "A simple command-line todo application built with Python"
   • Visibility: Public (so you can share your work)
   • Don't initialize with README, .gitignore, or license (since we're connecting an existing repository)
2. Connect your local repository:
   $ cd ~/path/to/python_todo_app $ git remote add origin git@github.com:your-username/python_todo_app.git
3. Push your code to GitHub:
   $ git push -u origin main
4. Verify on GitHub that your code has been uploaded

Exercise 2: Enhance Your Project's Documentation

1. Improve your README.md file:
   # Python Todo Application A command-line todo application built with Python. This app allows users to add, view, complete, and manage todo items with features like due dates and priorities. ## Features - Add and list todo items - Mark items as completed - Set due dates and priorities - Save todos to a file for persistence - Simple and intuitive command-line interface ## Installation 1. Clone this repository: ``` git clone https://github.com/your-username/python_todo_app.git cd python_todo_app ``` 2. No additional dependencies required! The app uses only Python standard library. ## Usage Run the application with: ``` python todo.py ``` ### Available Commands - `list` - Show all todo items - `add [text]` - Add a new todo item - `add [text] @YYYY-MM-DD` - Add todo with due date - `add [text] !high/!medium/!low` - Add with priority - `complete [num]` - Mark an item as completed - `save` - Save todos to file - `help` - Show help message - `quit` - Exit application (auto-saves) ## Example ``` $ python todo.py Welcome to the Todo App! Enter 'help' to see available commands. Enter command: add Buy groceries @tomorrow !high Added: Buy groceries (priority: high) (due: 2023-07-15) Enter command: add Schedule dentist appointment @2023-08-01 Added: Schedule dentist appointment (due: 2023-08-01) Enter command: list Todo List: 1. [ ] Buy groceries [!] (due: 2023-07-15) 2. [ ] Schedule dentist appointment (due: 2023-08-01) Enter command: complete 1 Completed: Buy groceries Enter command: list Todo List: 1. [✓] Buy groceries [!] (due: 2023-07-15) 2. [ ] Schedule dentist appointment (due: 2023-08-01) Enter command: quit Todos saved to file. Goodbye! ``` ## Contributing Contributions are welcome! Please feel free to submit a Pull Request. ## License This project is licensed under the MIT License - see the LICENSE file for details.
2. Create a LICENSE file:
   $ touch LICENSE

   Add the MIT License text (you can find this on GitHub when creating a new file named LICENSE)

3. Commit and push these changes:
   $ git add README.md LICENSE $ git commit -m "docs: Enhance project documentation with detailed README and license" $ git push

Exercise 3: Create a Feature Branch and Pull Request

1. Create a new branch for adding a search feature:
   $ git checkout -b feature/search-todos
2. Add the search functionality to todo.py:
   # Add this new function def search_todos(query, todos): """Search todos for a specific query string.""" if not query: print("Please provide a search term.") return query = query.lower() results = [] for i, todo in enumerate(todos): if query in todo['text'].lower(): results.append((i, todo)) if not results: print(f"No todos found matching '{query}'") return print(f"\nSearch results for '{query}':") for i, todo in results: status = "✓" if todo["completed"] else " " priority = todo.get("priority", "normal") priority_marker = "" if priority == "high": priority_marker = " [!]" elif priority == "low": priority_marker = " [.]" due_info = f" (due: {todo['due_date']})" if todo.get("due_date") else "" print(f"{i+1}. [{status}] {todo['text']}{priority_marker}{due_info}") # Update main() function to include the new search command def main(): todos = load_todos() print("Welcome to the Todo App!") print("Enter 'help' to see available commands.") while True: command = input("\nEnter command: ").strip().lower() if command == 'quit' or command == 'exit': save_todos(todos) print("Goodbye!") break elif command == 'help': print_help() elif command == 'list': list_todos(todos) elif command.startswith('add '): add_todo(command[4:], todos) elif command.startswith('complete '): try: index = int(command[9:]) - 1 complete_todo(index, todos) except ValueError: print("Please provide a valid number.") elif command == 'save': save_todos(todos) elif command.startswith('search '): search_todos(command[7:], todos) else: print("Unknown command. Enter 'help' to see available commands.") # Update print_help() to include the search command def print_help(): """Display available commands.""" print("\nAvailable commands:") print(" list - Show all todo items") print(" add [text] - Add a new todo item") print(" add [text] @YYYY-MM-DD - Add todo with due date") print(" add [text] @today/@tomorrow/@nextweek - Add with relative due date") print(" add [text] !high/!medium/!low - Add with priority") print(" complete [num] - Mark an item as completed") print(" search [text] - Search todos for specific text") print(" save - Save todos to file") print(" help - Show this help message") print(" quit - Exit the application (auto-saves)")
3. Test the new feature to make sure it works
4. Commit your changes:
   $ git add todo.py $ git commit -m "feat: Add search functionality for finding todos by keyword"
5. Push your branch to GitHub:
   $ git push -u origin feature/search-todos
6. Create a Pull Request on GitHub:
   • Go to your repository on GitHub
   • You should see a prompt to create a PR from your recently pushed branch
   • Click "Compare & pull request"
   • Fill in a descriptive title and description
   • Click "Create pull request"
7. Merge your own Pull Request:
   • Since this is your repository, you can approve and merge your own PR
   • Click "Merge pull request"
   • Click "Confirm merge"
8. Update your local main branch:
   $ git checkout main $ git pull

Exercise 4: Clone and Contribute to a Classmate's Repository

Pair up with a classmate or find an open-source project to contribute to:

1. Fork their repository on GitHub:
   • Navigate to their repository
   • Click the "Fork" button
2. Clone your fork locally:
   $ git clone git@github.com:your-username/their-repository.git $ cd their-repository
3. Add the original repository as "upstream":
   $ git remote add upstream git@github.com:their-username/their-repository.git
4. Create a branch for your contribution:
   $ git checkout -b feature/your-contribution
5. Make a meaningful change (add a feature, fix a bug, improve documentation)
6. Commit and push your changes:
   $ git add . $ git commit -m "feat: Add feature X" $ git push -u origin feature/your-contribution
7. Create a Pull Request from your fork to the original repository
8. Wait for feedback and collaborate with the repository owner