PyCharm 使用Github托管Django项目

不管是对于教程代码免费分享的需要,还是项目开发过程中的版本管理,Github都是我们首选的开源代码仓库,如果你没有私有仓库,并且不用保护代码,那么将项目上传到Github上是最佳的选择。

关于如何使用Git软件请自行学习,或许以后有空我也会写点教程。如何在PyCharm中配合Github,则在站点的博客中有一篇《PyCharm 在PyCharm中使用GitHub》,可供大家参考。

一、 创建requirements.txt文件

requirements.txt文件是一个项目的依赖库文件,可以通过下面的方式自动生成:

进入虚拟环境,切换到项目根目录下,使用pip工具的freeze参数。

(mysite_env) F:\Django_course\mysite>pip freeze  > ./requirements.txt

打开requirements.txt文件,其内容如下:

Django==1.11.7
django-simple-captcha==0.5.5
olefile==0.44
Pillow==4.3.0
pytz==2017.3
six==1.11.0

他人如果拷贝了我们的代码,要安装第三方库依赖的话,只需要:

pip install -r requirements.txt

就可以一次性安装好所有的库了。

二、创建.gitignore文件

在项目代码中,有一些文件是不能上传的,比如密码文件、数据库文件、核心配置文件等等,还有一些是不用上传的,比如临时文件。为了让git自动忽略这些文件,我们需要创建一个忽略名单。

在项目根目录下新建一个.gitignore文件,这里可能需要你在Pycharm下安装ignore插件,如下图所示:

我这里是已经安装好了,新安装的话,要在搜索栏里搜索到插件后再安装。

.gitignore文件里写入下面的内容:

.idea
settings.py
db.sqlite3
mysite/__pycache__/

这些文件将不会上传到Github中,也不会进行版本管理。

三、特殊文件处理

对于settings.py文件有个问题,如果没有这个文件是无法运行Django项目的,但是settings中又可能包含很多关键的不可泄露的部分,比如SECRET_KEY:

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = ‘b(&6i_$g2%8vh)ruu$)a9pkw+s-e&qj_e_#[email protected]^48#gp_8a‘

还有数据库的IP/port、用户名和密码,邮件发送端的用户名和密码,这些都是绝对不能泄露的。

那怎么办呢?简单!复制settings文件,并重命名为settings.example.py文件,放在同一目录里,把敏感信息、密码等修改或删除。使用者看到这个文件名,自然会明白它的作用。

四、添加说明文件和许可文件

通常我们要给Github的仓库添加说明文件和许可文件。

在项目根目录下创建一个README.md文件,这是markdown格式的。在文件里写入项目说明,使用方法,注意事项等等所有你认为需要说明的东西。

对于许可文件LICENSE,如果你暂时不想公开授权,或者不知道用哪种授权,可以暂时不提供。

下面是一个APACHE2.0授权的范例:

   mysite - User login and register system

   Copyright 2017- www.liujiangblog.com

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

五、上传代码

在上传过程中,确认文件列表的时候,一定要注意查看没有保密文件被上传。

等待一会,项目文件上传完毕后,进入Github的仓库页面,如下所示:

点击进入详细页面:

现在,所有人都可以通过下面的方式,下载和使用本项目的源代码了:

git clone https://github.com/feixuelove1009/liujiangblog_project_1

六、使用Github仓库中的源码

如果你不是从教程的开始一步步地实现整个项目,而是直接使用从Github上copy下来的整个源码,那么你可能需要做一些额外的工作,比如:

  • 创建虚拟环境
  • 使用pip安装第三方依赖
  • 修改settings.example.py文件为settings.py
  • 运行migrate命令,创建数据库和数据表
  • 运行python manage.py runserver启动服务器

而在Pycharm中运行服务器的话,可能还需要做一些额外的工作,比如:

  • 配置解释器
  • 配置启动参数

因为你本地Pycharm的配置情况,可能会发生不同的问题,需要根据实际情况实际处理,下面给两张配置图,供大家参考:

以上内容,都经过实际测试,如果你依然不能顺利启动服务器,请详细检查Pycharm的配置。

至此。

[参考出处:http://www.liujiangblog.com/course/django/115]

原文地址:https://www.cnblogs.com/wcwnina/p/9112364.html

时间: 2024-09-30 12:23:23

PyCharm 使用Github托管Django项目的相关文章

pycharm社区版创建django项目(Windows 8.1)

django是Python的一个开源web框架,在pycharm开发环境中,pycharm专业版在新建一个项目的时候有django选项,帮助创建一个django框架的项目.pycharm社区版需要自己创建 第一步:安装django框架 可以用pycharm安装,打开file \ setings \ project \ project interpreter  查看项目已安装的包,单击绿色加号添加目标框架, 注意记录django的安装路径,我的安装路径是:  c:\users\用户名\appdat

pycharm搭建第一个django项目

用pycharm开发django项目示例 pycharm开发django工程(一) 在pycharm(企业版)中新建Django工程,注意使用虚拟环境 创建成功后,在pycharm显示的工程目录结构如下: 打开pycharm的Terminal,进入该工程的目录新建一个django工程 python3 manage.py startapp django_web 执行成功后,工程目录结构如下: 修改settings.py文件,注册该工程 Django的开发遵循MTV模式(models, templa

Centos7 + nginx 托管 Django 项目

使用nginx托管django服务的原理 使用uwsgi开启django服务(通过配置文件启动) 防火墙关闭uwsgi端口(uwsgi的websocket一定要使用127.0.0.1的方式配置)) 编写nginx配置文件,通过nginx访问uwsgi,再通过uwsgi访问django 使用uwsgi测试django服务: # 确保出于和manage.py同一层目录 # module后xxx是项目的主名称,也就是包含wsgi.py文件的目录名称 # 此时uwsgi无法处理静态文件 uwsgi --

pycharm中配置启动Django项目

1.先打开mange.py,然后再运行,会提示一堆东西,表示没有配置参数.在pycharm中点击edit configurations 编辑配置参数. 2.点开之后弹出如下对话框,在scrip parameters 对应的对话框中输入配置参数 runserver 127.0.0.1:8000.配置完成之后点击ok就完成了. 3.配置完以上信息之后,直接运行一下manage.py文件:出现如下结果,表示配置成功. 4.在浏览器中输入 http://127.0.0.1:8000 原文地址:https

使用gitbash拉取github托管的项目到本地

原文地址:https://blog.csdn.net/qq_42625211/article/details/81636929 Git错误提示之:fatal: Not a git repository (or any of the parent directories): .git 解决方法:操作之前执行以下命令行: git init 原文地址:https://www.cnblogs.com/yerikm/p/10946056.html

Windows 下 pycharm 创建Django 项目【用虚拟环境的解释器】

1.  背景 我在 Windows 下的 pycharm  直接创建 全新 Django  项目 会  pip 和其他报错 ,暂时解决不了,另外后续的多个项目只需要一套python 环境, 所以可以 利用  virtualenv  创建一个 虚拟环境,pycharm  创建的 Django 项目 在选择解释器的时候    选择虚拟环境的解释器. 2.  virtualenv  安装 https://www.cnblogs.com/chenpython123/p/11517070.html 在 虚

django项目不能运行解决方法

当我们的django项目已经搭建起来以后,刚开始一直在cmd里面运行.想观察代码的某一部分输出是否正确的时候,只能把它传递给response,然后展现在网页上看是否正确.于是就想,能不能pycharm运行,因为这样可以print我们的一些东西,方便我们观察输出. 答案当然是可以的. ps:本文也可以解决pycharm出现 please Enable Django Support for the project的问题. 前提条件: 使用pycharm专业版,关于专业版的安装与激活,分享一下别人的网

Django项目的创建与管理和pycharm与Github的秘密

随笔 - 174  文章 - 21  评论 - 19 1.主题 这部分教程主要介绍如何通过Pycharm创建.管理.运行一个Django工程.对于Django模块的相关知识大家可以参考Python社区. 2.准备环境 Django版本为2.0或更高 Pycharm版本2017 Python3.6解释器 3.创建一个新工程 实际上所有工程的创建都可以通过单击Welcome screen界面上的Create New Project按钮来实现. 如果你已经打开了一个工程,可以通过菜单栏File → N

我应该如何在Pycharm中去运行别人的Django项目

django数据库迁移,本地运行 前言: 从网络上下载好django项目后,在本地用pycharm导入后,并不能运行.此时我们需要添加库和创建数据库. 零:这里是一个基于django写的小项目,可以作为参考: [发布会签到管理系统](https://github.com/threelu/untitled) 第一步:在项目的文件夹下面(含有manage.py),打开命令行输入: python manage.py migrate 第二步:命令行报错,如上图提示我们需要bootstrap3库 打开cm