Skip to main content

Simple GitHub Push Tool for Students & Developers

Project description

ProjectLaunch 🚀

Python Version License PyPI Downloads

Simple GitHub Push Tool for Students & Developers

Push your projects to GitHub with a single command. No complex git commands needed!


🎯 What Does It Do?

ProjectLaunch simplifies pushing your code to GitHub:

  • ✅ Automatically initializes git repository
  • ✅ Adds all your files
  • ✅ Creates a commit with your message
  • ✅ Pushes to your GitHub repository
  • ✅ All in one command!

📦 Installation

pip install projectlaunch

Requirements:

  • Python 3.8 or higher
  • Git installed on your system (Download Git)

🚀 Quick Start

Basic Usage (Interactive)

Navigate to your project folder and run:

pl push

The tool will ask you:

  1. GitHub repository URL - Example: https://github.com/username/my-project
  2. Commit message - Example: Initial commit or Added new features

That's it! Your code is now on GitHub! 🎉


💡 Usage Examples

Example 1: Interactive Mode (Recommended for Beginners)

cd my-project
pl push

Output:

ProjectLaunch - GitHub Push Tool

Enter your GitHub repository URL:
Repository URL: https://github.com/username/my-project

Enter commit message:
Commit message [Initial commit]: Added homepage

Pushing to GitHub...
✓ Initializing git...
✓ Adding files...
✓ Committing: Added homepage
✓ Setting remote...
✓ Pushing...

Successfully pushed!
Repository: https://github.com/username/my-project

Example 2: With Command-Line Options (Faster)

pl push --repo https://github.com/username/my-project --message "Initial commit"

Short version:

pl push -r https://github.com/username/my-project -m "Initial commit"

Example 3: Push from Different Directory

pl push --path /path/to/your/project --repo https://github.com/username/repo

📖 Command Reference

Main Command

pl push [OPTIONS]

Options

Option Short Description Example
--repo -r GitHub repository URL --repo https://github.com/user/repo
--message -m Commit message --message "Fixed bugs"
--path -p Project directory path --path ./my-project
--help -h Show help message --help

Other Commands

pl --version          # Show version
pl --help            # Show all commands
projectlaunch push   # Full command name (same as 'pl push')

🎓 Step-by-Step Tutorial

First Time Setup

Step 1: Create a GitHub Repository

  1. Go to GitHub
  2. Click the + icon → New repository
  3. Enter repository name (e.g., my-awesome-project)
  4. Click Create repository
  5. Copy the repository URL (e.g., https://github.com/username/my-awesome-project)

Step 2: Install ProjectLaunch

pip install projectlaunch

Step 3: Navigate to Your Project

cd path/to/your/project

Step 4: Push to GitHub

pl push

Enter the repository URL you copied in Step 1, and you're done! 🎉


🔧 Common Scenarios

Scenario 1: First Time Pushing a New Project

cd my-new-project
pl push
# Enter: https://github.com/username/my-new-project
# Enter: Initial commit

Scenario 2: Updating an Existing Project

cd my-existing-project
pl push -r https://github.com/username/my-existing-project -m "Updated features"

Scenario 3: Quick Push with Default Message

pl push -r https://github.com/username/repo
# Uses default message: "Initial commit"

❓ FAQ

Q: Do I need to create a GitHub repository first?

A: Yes! Create an empty repository on GitHub first, then use ProjectLaunch to push your code.

Q: What if I already have a git repository?

A: No problem! ProjectLaunch will detect it and just push your changes.

Q: Can I use this for private repositories?

A: Yes! Just make sure you're logged into GitHub on your system.

Q: What if the push fails?

A: ProjectLaunch will automatically try force push. Make sure:

  • Git is installed
  • You have internet connection
  • The repository URL is correct
  • You have permission to push to the repository

Q: Does it work on Windows/Mac/Linux?

A: Yes! Works on all platforms where Python and Git are installed.


🛠️ Troubleshooting

Error: "Git not installed"

Solution: Install Git from git-scm.com


Error: "Permission denied"

Solution: Make sure you're logged into GitHub:

git config --global user.name "Your Name"
git config --global user.email "your@email.com"

Error: "Repository not found"

Solution:

  1. Check the repository URL is correct
  2. Make sure the repository exists on GitHub
  3. Verify you have access to the repository

🎯 Real-World Examples

Example 1: Student Project

# You just finished your college project
cd final-year-project
pl push -r https://github.com/student123/final-year-project -m "Completed project"

Example 2: Quick Prototype

# You built a quick prototype and want to share it
cd prototype-app
pl push
# Enter repo URL and message when prompted

Example 3: Daily Updates

# End of day, pushing your work
cd work-project
pl push -r https://github.com/company/work-project -m "Day 5: Implemented login feature"

📝 Tips & Best Practices

  1. Use descriptive commit messages

    • ❌ Bad: "update"
    • ✅ Good: "Added user authentication feature"
  2. Push regularly

    • Don't wait until the end of the project
    • Push after completing each feature
  3. Check your files

    • Make sure you're not pushing sensitive data (passwords, API keys)
    • Use .gitignore to exclude unnecessary files
  4. Create a .gitignore file

    # Common files to ignore
    __pycache__/
    *.pyc
    .env
    node_modules/
    .DS_Store
    

🆘 Need Help?


📄 License

MIT License - Free to use for everyone!


🙏 Credits

Built for students and developers who want a simpler way to push code to GitHub.


Made with ❤️ by Madhan


Quick Reference Card

# Install
pip install projectlaunch

# Basic usage
pl push

# With options
pl push -r https://github.com/user/repo -m "Commit message"

# Get help
pl --help

# Check version
pl --version

Happy Coding! 🚀

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

projectlaunch-1.0.1.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

projectlaunch-1.0.1-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file projectlaunch-1.0.1.tar.gz.

File metadata

  • Download URL: projectlaunch-1.0.1.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for projectlaunch-1.0.1.tar.gz
Algorithm Hash digest
SHA256 6ea8c602b55e35e89a5f89494289e3821ba41814196bf1e4fff1d0dab420afa1
MD5 8690dd6ee7a6fe050de8e4cd94961c8d
BLAKE2b-256 699c320ffb1a4ed239d32b53a9d58ed406f0302ce9702953b55c549dcf7b5990

See more details on using hashes here.

File details

Details for the file projectlaunch-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: projectlaunch-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for projectlaunch-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b34fe4b4897692427b3778ef6b4daac2110b93ac7619da5bf935d13d08d6844d
MD5 bab6978072df6a888c0b969ac91c8c95
BLAKE2b-256 77487a7dd9683e902c2bb2b1842df6e32ea1e777757f162c551b665458911d63

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page