-
Notifications
You must be signed in to change notification settings - Fork 0
/
GitSwift-main\README.html
138 lines (129 loc) · 5.55 KB
/
GitSwift-main\README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>GitSwift - README</title>
<style>
body {
background-color: #2e2e2e;
color: #ffffff;
font-family: Arial, sans-serif;
line-height: 1.6;
padding: 20px;
}
a {
color: #1e90ff;
}
h1, h2, h3 {
color: #ffffff;
}
code {
background-color: #3e3e3e;
color: #dcdcdc;
padding: 2px 4px;
border-radius: 4px;
}
pre {
background-color: #3e3e3e;
padding: 10px;
border-radius: 4px;
overflow-x: auto;
}
.badge {
display: inline-block;
padding: 5px 10px;
background-color: #5e5e5e;
border-radius: 4px;
margin-right: 5px;
font-size: 12px;
}
</style>
</head>
<body>
<h1>GitSwift</h1>
<div>
<span class="badge">License: MIT</span>
<span class="badge">Python: 3.6+</span>
<span class="badge">PyQt5</span>
</div>
<h2>Table of Contents</h2>
<ul>
<li><a href="#introduction">Introduction</a></li>
<li><a href="#features">Features</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#usage">Usage</a></li>
<li><a href="#requirements">Requirements</a></li>
<li><a href="#example-use-case">Example Use Case</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
</ul>
<h2 id="introduction">Introduction</h2>
<p>
GitSwift is a user-friendly GUI application designed to simplify the process of uploading your local projects to GitHub. Whether you're a seasoned developer or just starting out, GitSwift provides an intuitive interface to manage your repositories, handle authentication tokens securely, and ensure your code is hosted effortlessly.
</p>
<h2 id="features">Features</h2>
<ul>
<li><strong>Secure Token Management:</strong> Save and manage multiple GitHub Personal Access Tokens.</li>
<li><strong>Easy Repository Creation:</strong> Create new repositories with descriptions, visibility settings, and license options.</li>
<li><strong>Seamless File Uploads:</strong> Upload your project files directly to GitHub with just a few clicks.</li>
<li><strong>User-Friendly Interface:</strong> Built with PyQt5 for a smooth and responsive user experience.</li>
<li><strong>Error Handling & Status Logs:</strong> Receive real-time feedback and status updates during the upload process.</li>
</ul>
<h2 id="installation">Installation</h2>
<p><strong>Clone the Repository:</strong></p>
<pre><code>git clone https://github.com/yourusername/GitSwift.git</code></pre>
<p><strong>Navigate to the Project Directory:</strong></p>
<pre><code>cd GitSwift</code></pre>
<p><strong>Install Required Dependencies:</strong></p>
<pre><code>pip install -r requirements.txt</code></pre>
<h2 id="usage">Usage</h2>
<ol>
<li><strong>Run the Application:</strong>
<pre><code>python "GitSwift.py"</code></pre>
</li>
<li><strong>Authenticate:</strong>
<ul>
<li>Enter your GitHub Personal Access Token.</li>
<li>Optionally save the token for future use.</li>
</ul>
</li>
<li><strong>Select Project Directory:</strong>
<ul>
<li>Browse and select the local project folder you wish to upload.</li>
</ul>
</li>
<li><strong>Configure Repository Settings:</strong>
<ul>
<li>Specify repository name, description, visibility, and license.</li>
</ul>
</li>
<li><strong>Upload to GitHub:</strong>
<ul>
<li>Click on the "Upload to GitHub" button to initiate the upload process.</li>
</ul>
</li>
<li><strong>Monitor Status:</strong>
<ul>
<li>View real-time status updates in the status display area.</li>
</ul>
</li>
</ol>
<h2 id="requirements">Requirements</h2>
<p>Ensure you have Python 3.6 or higher installed. Install the necessary packages using the following commands:</p>
<pre><code>pip install PyQt5
pip install PyGithub</code></pre>
<h2 id="example-use-case">Example Use Case</h2>
<p><strong>Scenario:</strong> You're a freelance developer working on a client's project locally. Once the project is complete, you want to upload it to GitHub for version control and future collaboration.</p>
<ul>
<li>Open GitSwift and authenticate with your GitHub account.</li>
<li>Select the client's project directory.</li>
<li>Enter a repository name, add a description, choose visibility, and select an appropriate license.</li>
<li>Click "Upload to GitHub" and monitor the upload status.</li>
<li>Once completed, share the repository link with your client for access and collaboration.</li>
</ul>
<h2 id="contributing">Contributing</h2>
<p>Contributions are welcome! Please fork the repository and submit a pull request for any enhancements or bug fixes.</p>
<h2 id="license">License</h2>
<p>This project is licensed under the <a href="LICENSE">MIT License</a>.</p>
</body>
</html>