Skip to content

Latest commit

 

History

History
243 lines (176 loc) · 5.86 KB

SETUP_GITHUB.md

File metadata and controls

243 lines (176 loc) · 5.86 KB

🚀 Setting Up the Project on GitHub

This guide will help you upload this project to GitHub and make it ready for others to download and use.

Step 1: Create a GitHub Repository

  1. Go to GitHub.com and sign in
  2. Click the "+" icon in the top right corner
  3. Select "New repository"
  4. Repository name: from-protege-to-production-python (or your preferred name)
  5. Description: "From Protégé to Production: Integrating OWL Ontologies with Python using Owlready2 and Flask"
  6. Choose Public (or Private if you prefer)
  7. DO NOT check "Initialize with README" (we already have one)
  8. Click "Create repository"

Step 2: Initialize Git (if not already done)

Open terminal/command prompt in your project directory and run:

# Check if git is already initialized
git status

# If not initialized, run:
git init

Step 3: Add All Files to Git

# Add all files
git add .

# Check what will be committed
git status

# Commit the files
git commit -m "Initial commit: Complete DineWise project with tests"

Step 4: Connect to GitHub

# Add the remote repository (replace YOUR_USERNAME with your GitHub username)
git remote add origin https://github.com/YOUR_USERNAME/from-protege-to-production-python.git

# Or if using SSH:
git remote add origin git@github.com:YOUR_USERNAME/from-protege-to-production-python.git

# Verify the remote
git remote -v

Step 5: Push to GitHub

# Push to GitHub (first time)
git branch -M main
git push -u origin main

Step 6: Verify Upload

  1. Go to your GitHub repository page
  2. Verify all files are uploaded:
    • ✅ README.md
    • ✅ QUICKSTART.md
    • ✅ All Python files (.py)
    • ✅ restaurant-ontology.owl
    • ✅ requirements.txt
    • ✅ tests/ directory
    • ✅ LICENSE

Step 7: Update Repository URL in Documentation

After pushing, update the repository URL in these files:

  1. README.md - Replace <your-repository-url> with your actual URL
  2. QUICKSTART.md - Replace <your-repository-url> with your actual URL
  3. CONTRIBUTING.md - Update repository URL if needed

Example:

# Before
git clone <your-repository-url>

# After
git clone https://github.com/YOUR_USERNAME/from-protege-to-production-python.git

Then commit and push:

git add README.md QUICKSTART.md
git commit -m "Update repository URLs in documentation"
git push

Step 8: Add Repository Topics (Optional but Recommended)

On GitHub, click the ⚙️ gear icon next to "About" section and add topics:

  • python
  • owl-ontology
  • owlready2
  • flask
  • rest-api
  • semantic-web
  • ontology-reasoning
  • tutorial

Step 9: Enable GitHub Actions (Optional)

The project includes a GitHub Actions workflow for automated testing.

  1. Go to the "Actions" tab in your repository
  2. Click "I understand my workflows, go ahead and enable them"
  3. The workflow will run automatically on push and pull requests

Step 10: Add a Repository Description

On GitHub repository page, edit the description to:

A complete tutorial project demonstrating OWL ontology integration with Python, from Protégé to production-ready REST API. Includes Owlready2, Flask, and comprehensive test suite.

✅ Checklist for GitHub Setup

  • Repository created on GitHub
  • Git initialized locally
  • All files added and committed
  • Remote repository connected
  • Code pushed to GitHub
  • Files visible on GitHub
  • Repository URLs updated in documentation
  • README.md displays correctly
  • Topics added (optional)
  • GitHub Actions enabled (optional)
  • Description added (optional)

🔄 Future Updates

When you make changes:

# 1. Check what changed
git status

# 2. Add changed files
git add .

# 3. Commit with a descriptive message
git commit -m "Description of your changes"

# 4. Push to GitHub
git push

📝 Example: Complete Setup Flow

# 1. Initialize git (if needed)
git init

# 2. Add all files
git add .

# 3. Make initial commit
git commit -m "Initial commit: Complete DineWise project"

# 4. Add remote (replace YOUR_USERNAME)
git remote add origin https://github.com/YOUR_USERNAME/from-protege-to-production-python.git

# 5. Push to GitHub
git branch -M main
git push -u origin main

🔗 Sharing Your Repository

Once uploaded, share the repository URL:

Repository URL format:

https://github.com/YOUR_USERNAME/from-protege-to-production-python

Clone command for others:

git clone https://github.com/YOUR_USERNAME/from-protege-to-production-python.git

📋 File Checklist

Before pushing, ensure these files exist:

  • ✅ README.md - Main documentation
  • ✅ QUICKSTART.md - Quick start guide
  • ✅ CONTRIBUTING.md - Contribution guidelines
  • ✅ LICENSE - MIT License
  • ✅ requirements.txt - Dependencies
  • ✅ .gitignore - Git ignore file
  • ✅ restaurant-ontology.owl - Base ontology
  • ✅ All Python scripts (.py files)
  • ✅ tests/ directory with all test files
  • ✅ pytest.ini - Pytest configuration
  • ✅ .github/workflows/ - CI/CD workflows (optional)

🐛 Troubleshooting

Problem: "Repository not found"

Solution: Check that you've added the correct remote URL and have access to the repository.

Problem: "Permission denied"

Solution: Make sure you're authenticated with GitHub:

  • For HTTPS: Use personal access token
  • For SSH: Set up SSH keys

Problem: Large file warnings

Solution: Check .gitignore is working. Some files should be excluded (like __pycache__, .pyc files).

Problem: "Failed to push"

Solution:

# Pull first, then push
git pull origin main --rebase
git push origin main

🎉 Success!

Once uploaded, anyone can:

  1. Clone your repository
  2. Follow QUICKSTART.md to set up and run the project
  3. Run tests to verify everything works
  4. Contribute improvements

Your project is now on GitHub! 🚀