├── .gitignore ├── LICENSE ├── README.md ├── github_storages ├── __init__.py ├── admin.py ├── apps.py ├── backend.py └── utils.py ├── setup.cfg └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | dist/ 2 | django_github_s3.egg-info -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # django-github-s3 2 | 3 | ### Installation 4 | Installing from PyPi: 5 | 6 | $ pip install django-github-s3 7 | 8 | Once the installation is done, setup the following in the settings.py file. 9 | 10 | Include the following package in the INSTALLED_APPS 11 | 12 | INSTALLED_APPS = [ 13 | .... 14 | 'github_storages', 15 | ] 16 | 17 | After including the package setup the following in the settings.py 18 | 19 | DEFAULT_FILE_STORAGE = "github_storages.backend.BackendStorages" 20 | GITHUB_HANDLE = "Your Github Handle" 21 | ACCESS_TOKEN = "Your Github Access Token" 22 | GITHUB_REPO_NAME = "Your New Github Public Repository Name" 23 | MEDIA_BUCKET_NAME = "Your media bucket name" 24 | 25 | For Example: 26 | 27 | DEFAULT_FILE_STORAGE = "github_storages.backend.BackendStorages" 28 | GITHUB_HANDLE = "vivekchandrabs" 29 | ACCESS_TOKEN = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" 30 | GITHUB_REPO_NAME = "Example-Test-Repo" 31 | MEDIA_BUCKET_NAME = "media" 32 | 33 | **Here is a video on how to get the [GitHub Access Token](https://www.loom.com/share/1ac9b95756e242c290e2329683737c2f)** 34 | 35 | 36 | If you are using ImageField or FileField upload_to parameter can be specified for better organization of files. 37 | 38 | photo = models.ImageField(upload_to="pics/", null=True, blank=True) 39 | 40 | ## About 41 | django-github-s3 is a project to provide beginners a storage backend on github for free. 42 | 43 | Since other simple-storage-services requires credit-card information to setup an account and get started. 44 | There is a lot of traction in between for the beginners. 45 | 46 | Therefore django-github-s3 helps beginners to store the media files on github with very less number of steps required in the initial setup. 47 | 48 | ## Found a Bug? Something Unsupported? 49 | Issues are tracked via GitHub issues at the [project issue page](https://github.com/vivekchandrabs/django-github-s3/issues). 50 | 51 | ## Contributing 52 | 1. [Check for open issues](https://github.com/vivekchandrabs/django-github-s3/issues) at the project issues page or open a new issues to start a discussion about a feature or bug 53 | 2. Fork the [django-github-s3 repository on GitHub](https://github.com/vivekchandrabs/django-github-s3) to start making changes in your own branch. 54 | 55 | ## Warning !!! 56 | The github repository that you have to create should be public. Storing any confidential information is not recommended. 57 | 58 | ## Thanks To: 59 | 60 | * [Vidyadhar Sharma](https://github.com/justvidyadhar) for guiding me throughout this project. 61 | * [Speckbit Exploratories](https://www.speckbit.com) for giving me this opportunity. 62 | 63 | 64 | 65 | 66 | 67 | 68 | -------------------------------------------------------------------------------- /github_storages/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vivekchandrabs/django-github-s3/ad510bb26be33a49903cc71203a1980c3bb3f4a1/github_storages/__init__.py -------------------------------------------------------------------------------- /github_storages/admin.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | # Register your models here. 3 | -------------------------------------------------------------------------------- /github_storages/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | class StoragesGithubConfig(AppConfig): 4 | name = 'github_storages' 5 | -------------------------------------------------------------------------------- /github_storages/backend.py: -------------------------------------------------------------------------------- 1 | # Github storage class for Django pluggable storage system. 2 | # 3 | # Author: Vivek Chandra B S 4 | # 5 | # License: Mozilla Public License Version 2.0 6 | # 7 | # Usage: 8 | # 9 | # Add below settings.py: 10 | # DEFAULT_FILE_STORAGE = "github_storages.backend.BackendStorages" 11 | # GITHUB_HANDLE = 'Your Github Handle' 12 | # ACCESS_TOKEN = "Your Github Access Token" 13 | # GITHUB_REPO_NAME = "Your Github Repository Name" 14 | # MEDIA_BUCKET_NAME = "Media Bucket Name" 15 | 16 | import requests 17 | import simplejson as json 18 | import base64 19 | import os 20 | import posixpath 21 | import random 22 | 23 | from django.conf import settings 24 | from django.core.files.storage import Storage 25 | from django.utils.encoding import force_text 26 | from django.conf import settings 27 | from django.db import models 28 | 29 | from github_storages.utils import get_url 30 | 31 | class BackendStorages(Storage): 32 | """ Github Backend storage class for Django pluggable storage system.""" 33 | 34 | def __init__(self): 35 | ''' Get all the credentials from the settings.py file 36 | and initialize them to global variables. 37 | ''' 38 | self.github_handle = settings.GITHUB_HANDLE 39 | self.token = settings.ACCESS_TOKEN 40 | self.repo_name = settings.GITHUB_REPO_NAME 41 | 42 | try: 43 | self.media_bucket = settings.MEDIA_BUCKET_NAME 44 | except: 45 | self.media_bucket = None 46 | 47 | def url(self, name): 48 | return name 49 | 50 | def save(self, name, content, max_length=None): 51 | ''' Saves the file uploaded from the user side to github ''' 52 | 53 | path_with_file_name = posixpath.basename(name).split("\\") 54 | name = path_with_file_name.pop() 55 | path = path_with_file_name 56 | 57 | return self._save(name, path, content) 58 | 59 | def _save(self, name, path, content): 60 | ''' 61 | :Required: 62 | name || (name of file) || type string 63 | content || (content of the file) 64 | 65 | :Action: 66 | * Check for the available file name in the github. 67 | * If found then calls the upload_file_to_git function 68 | 69 | :Returns: 70 | * Download URL of the file 71 | 72 | ''' 73 | while True: 74 | if self.exists(name, path): 75 | name = self.get_available_name(name) 76 | else: 77 | break 78 | 79 | response = self.upload_file_to_git(name, path, content) 80 | 81 | return response["content"]["download_url"] 82 | 83 | def exists(self, name, path): 84 | ''' 85 | :Required: 86 | name || (name of the file) || type string 87 | 88 | :Action: 89 | * Gets the fetch url from the get_url method. 90 | * Fetchs the response from the git using requests library 91 | 92 | :Returns: 93 | * Returns True if File exists on github 94 | * Returns False if File does not exits on github 95 | 96 | ''' 97 | 98 | fetch_url = get_url(name, path, self.media_bucket) 99 | response = requests.get(fetch_url) 100 | 101 | if response.status_code == 200: 102 | return True 103 | else: 104 | return False 105 | 106 | def get_available_name(self, name, max_length=None): 107 | ''' 108 | :Required: 109 | name || (name of the file) || type string 110 | 111 | :Action: 112 | * Appends a random hash value to the file name 113 | 114 | :Returns: 115 | * New file name 116 | ''' 117 | 118 | random_hash = random.random() * 1000 119 | name = str(int(random_hash)) + name 120 | return name 121 | 122 | def upload_file_to_git(self, name, path, content): 123 | ''' 124 | :Required: 125 | name || (name of the file) || type string 126 | content || Content of the file 127 | 128 | :Action: 129 | * Gets the upload_url from the get_url method 130 | * Constructs the payload. 131 | * Sends put request to the upload_url with payload and headers. 132 | 133 | :Returns 134 | * Content of the response obtained from the github. 135 | 136 | :Raise Errors: 137 | * If github returns 404 status_code. 138 | 139 | ''' 140 | 141 | upload_url = get_url(name, path, self.media_bucket) 142 | 143 | headers ={"Authorization": f"token {self.token}"} 144 | 145 | payload = {} 146 | payload["message"] = name 147 | payload["committer"] = {} 148 | payload["committer"]["name"] = "Monalisa Octocat" 149 | payload["committer"]["email"] = "octocat@github.com" 150 | payload["content"] = self.convert_to_base64(content) 151 | 152 | response = requests.put(url= upload_url, data=json.dumps(payload), headers=headers) 153 | 154 | if response.status_code == 404: 155 | raise IOError(response.content) 156 | 157 | json_data = json.loads(response.content) 158 | return json_data 159 | 160 | def convert_to_base64(self, content): 161 | ''' 162 | :Required: 163 | content || Content of the uploaded file 164 | 165 | :Action: 166 | * Converts the content of the file to base64 format. 167 | 168 | :Returns: 169 | base64 format string. 170 | ''' 171 | 172 | my_string = base64.b64encode(content.read()) 173 | return my_string 174 | 175 | def delete(self, name): 176 | ''' 177 | :Required: 178 | name || (name of the file) || type string 179 | 180 | :Action: 181 | * Gets the fetch url from the get_url method 182 | * Gets the response from the github for the particular content 183 | * Extracts the sha from the response 184 | 185 | * Constructs the payload along with the sha 186 | * Gets the delete url from the get_url methods. 187 | * Calls delete url with the delete method. 188 | 189 | :Returns: 190 | True upon proper deletion of the file. 191 | 192 | :Raise: 193 | If the file does not exists || status_code = 404 194 | ''' 195 | 196 | image_path = self.url(name).split("/master/")[-1] 197 | 198 | path_with_file_name = image_path.split("/") 199 | name = path_with_file_name.pop() 200 | 201 | if path_with_file_name[0] == self.media_bucket: 202 | del path_with_file_name[0] 203 | 204 | path = path_with_file_name 205 | 206 | delete_url = get_url(name, path, self.media_bucket) 207 | headers = {"Authorization": f"token {self.token}"} 208 | 209 | fetch_url = get_url(name, path, self.media_bucket) 210 | response = requests.get(fetch_url) 211 | 212 | try: 213 | json_data = json.loads(response.content) 214 | sha = json_data["sha"] 215 | 216 | except: 217 | raise IOError(response.content) 218 | 219 | delete_url = get_url(name, path, self.media_bucket) 220 | headers = {"Authorization": f"token {self.token}"} 221 | 222 | payload = {} 223 | payload["message"] = name 224 | payload["committer"] = {} 225 | payload["committer"]["name"] = "Monalisa Octocat" 226 | payload["committer"]["email"] = "octocat@github.com" 227 | payload["sha"] = sha 228 | 229 | response = requests.delete(url=delete_url, data=json.dumps(payload), headers=headers) 230 | 231 | if response.status_code == 404: 232 | raise IOError(response.content) 233 | 234 | return 1 235 | 236 | def size(self, name): 237 | ''' 238 | :Required: 239 | name || (name of the file) || type string 240 | 241 | :Action: 242 | * Gets the Image url from the get_url method 243 | * Gets the response from the github for the particular content 244 | * Extracts the size from the response. 245 | 246 | :Returns: 247 | Size of the Image 248 | 249 | :Raise: 250 | If the file does not exists || status_code = 404 251 | ''' 252 | name = str(name) 253 | 254 | image_path = self.url(name).split("/master/")[-1] 255 | path_with_file_name = image_path.split("/") 256 | name = path_with_file_name.pop() 257 | 258 | if path_with_file_name[0] == self.media_bucket: 259 | del path_with_file_name[0] 260 | 261 | path = path_with_file_name 262 | get_size_url = get_url(name, path, self.media_bucket) 263 | 264 | headers = {"Authorization": f"token {self.token}"} 265 | response = requests.get(get_size_url, headers) 266 | 267 | if response.status_code == 404: 268 | raise IOError(response.content) 269 | 270 | json_data = json.loads(response.content) 271 | 272 | return json_data['size'] 273 | -------------------------------------------------------------------------------- /github_storages/utils.py: -------------------------------------------------------------------------------- 1 | from django.conf import settings 2 | 3 | def get_url(name, path, media_bucket): 4 | ''' 5 | Helper function to construct the url of the file. 6 | ''' 7 | url = "https://api.github.com/repos/" 8 | url += str(settings.GITHUB_HANDLE) + "/" 9 | url += str(settings.GITHUB_REPO_NAME) 10 | url += "/contents/" 11 | 12 | if media_bucket == None: 13 | url += str(name) 14 | else: 15 | url += str(media_bucket) + "/" 16 | 17 | if len(path) != 0: 18 | for folder_name in path: 19 | url += str(folder_name) + "/" 20 | 21 | url += str(name) 22 | 23 | return url 24 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | # Inside of setup.cfg 2 | [metadata] 3 | description-file = README.md -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | with open("README.md", "r") as fh: 4 | long_description = fh.read() 5 | 6 | setup( 7 | name='django-github-s3', 8 | version="v0.25", 9 | packages=['github_storages',], 10 | python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*", 11 | install_requires=['django>=1.11', "Pillow>=6.2.1", "requests>=2", "simplejson==3.16.0"], 12 | extras_require={ 13 | 'libcloud': ['apache-libcloud'], 14 | 'sftp': ['paramiko'], 15 | }, 16 | author='Vivek Chandra B S', 17 | author_email='vivek.chandra.301096@gmail.com', 18 | license='Mozilla Public License Version 2.0', 19 | description='django-github-s3 is a package for Django to provide beginners a storage backend on github for free.', 20 | long_description=long_description, 21 | long_description_content_type="text/markdown", 22 | url='https://github.com/vivekchandrabs/django-github-s3/archive/V_04.tar.gz', 23 | classifiers=[ 24 | 'Development Status :: 5 - Production/Stable', 25 | 'Environment :: Web Environment', 26 | 'Framework :: Django', 27 | 'Framework :: Django :: 1.11', 28 | 'Framework :: Django :: 2.0', 29 | 'Framework :: Django :: 2.1', 30 | 'Framework :: Django :: 2.2', 31 | 'Intended Audience :: Developers', 32 | 'License :: OSI Approved :: BSD License', 33 | 'Operating System :: OS Independent', 34 | 'Programming Language :: Python', 35 | 'Programming Language :: Python :: 2', 36 | 'Programming Language :: Python :: 2.7', 37 | 'Programming Language :: Python :: 3', 38 | 'Programming Language :: Python :: 3.4', 39 | 'Programming Language :: Python :: 3.5', 40 | 'Programming Language :: Python :: 3.6', 41 | 'Programming Language :: Python :: 3.7', 42 | ], 43 | zip_safe=False 44 | ) --------------------------------------------------------------------------------