怎么将自己写的包打包上传到PyPi供其他人下载

打包和上传依赖wheel和twine这两个包。

比方说我们想写这样一个包，这个包只有一个功能，那就是打印程序员佛祖字符画。

这个包就提供了一个佛祖字符画和一个打印函数。

__main__.py 让这个包可以被 python -m 直接运行，而 __main__.py 其实也就只干了一件事，那就是调用 print_buddha 打印字符画。

打包项目你需要学习以下知识

加星的是必须的，其他的可有可无不影响打包和上传PyPi，就是不规范而已。

最基本的 setup.py

然后我们试一下打包：

这是个组合命令，意思是先打sdist，再打bdist_wheel。

sdist打出来的是tar.gz格式压缩包，里面就是包源文件，可以供直接解压然后 python setup.py install 安装。

bdist_wheel打出来的是whl格式文件，这是pip官方安装包文件格式。

注意：egg格式已经过时了，现在PyPi的包都是用whl格式。

PiPy上传规范是同时要tar.gz和whl两个格式的包。

注意：打了星的是必须参数

描述性参数只是作为PKG_INFO用的，没有什么特殊作用，就是描述用的，用来供pip和PyPi管理的，因此看上面就可以了。

setup.py 需要提供以上参数数据用来搜集需要打到包里的文件:

注意：打了星的是重要参数

根据上面的说明，我们来演练一下。首先项目要做些修改和添加一些功能。

接着修改setup.py:

注意： data_files 、 scripts 这两个参数不享受 package_dir 的效果，必须指定根目录下相对路径。

打包看看：

试一下安装：

我们去PYTHON_HOME看看我们的包被安装到哪里。

我袜凯们的包各种文件都被安装到了我们想要的位置。

试一下命令行调用 buddha.bat :

python里导入 buddha 模块：

python里导入 single_module 模块：

例子：

更加详细的说明可以去参考官方文档《 setuptools documeng: Building and Distributing Packages with Setuptools 》

到 PyPi 官网注册一个账号，通过各种验证通。

将dist下的tar.gz和whl文件上传到PyPi。

会提示输入用户名密码，照着做就告凳唤行。

上传成功后就会出现在PyPi和你的项目页里。

你无法重新上传覆盖版本，所粗贺以如果你的包有bug或者有修改，你必须修改setup.py里的version，然后再打一次包上传。

转自：IntelliJ IDEA必装插件以及SpringBoot使 IntelliJ IDEA必装插件

有不知道怎么安装的吗？File-->settings打开设置面板，找到plugins,输入想要安装的插件回车即可。plugins面板

1.背景图片

目前，IDEA支持设置背景图片。这对于广大程序员来说无疑是消配模个好功能。整日对着枯燥的代码实在是会让人疲乏。要是可以设置一张美女图片的话。。。

设置方法：

Ctrl+Shift+A(或者help ->find action)调用d窗后输入Set Background Image。

在里面设定要设置为Image的图片,透明度调到15左右，保存即可。

效果如图：

2.Maven Helper

日常开发中，可能经常会遇到jar包冲突等问题，就需要通过查看maven依赖树来查看依赖情况。这种方式不是很高效，这里推荐一个插件，安装之后，直接打开pom文件，即可查看依赖数，还能自动分析是否存在jar包冲突。

一旦安装了卖薯Maven Helper插件，只要打开pom文件，就可以打开该pom文件的Dependency Analyzer视图（在文件打开之后，文件下面会多出这样一个tab）。

进入Dependency Analyzer视图之后有三个查看选项分别是：

Conflicts(冲突)

All Dependencies as List(列表形式查看所有依赖)

All Dependencies as Tree(树结构查看所有依赖)，并且这个页面还支持搜索。

3.FindBugs-IDEA

FindBugs很多人都并不陌生，Eclipse中有插件可以帮助查找代码中隐藏的bug，IDEA中也有这款插件。

使用方法很简单，就是可以对多种级别的内容进行finbugs。

分析完之后会有一个视图进行提示，详细的说明是哪种问题。

4.阿里巴巴代码规约检测

检测JAVA代码中存在不规范得位置然后给予提示,阿里巴巴规约插件包含三个子菜单：编码规约扫描、关闭试试检测功能。

安装好此插件即可自动在不规范位置给与提示。

5.GsonFormat

Java开发中，经常有把json格式的内容转成Object的需求，比如项目开始时，合作方给你提供了一个json格式request/response，这时候你就需要将其定义成一个Java类，GsonFormat这款插件可以实现该功能。

6.Lombok plugin

在Java中，我们经常会定义很多JavaBean，这些Bean需要有getter、setter、toString、equals和hashCode等方法。

通常情况下，我们可以使用IDEA的快捷键生成这些代码，但是自动生成的代码后，如果bean中的属性一旦有修改，需要重新生成，给代码维护增加了一定的负担。

有一款很好的插件，可以帮助开发者节省这部分工作。那就是Lombok。

只要在IDEA中安装了该插件，只需要在JavaBean中添加一行注解代码，插件就会自动帮我们生成getter、setter、拿缓toString、equals和hashCode等方法。

当然，这些方法不止在IDE中的代码调用中需要用到，在真正线上部署的时候也需要有，所以，还需要使用maven引入一个lombok的包。

@Data class Wechat {

private String id

private String desc }

我们在Wechat类上面添加了@Data注解，插件就自动帮我们添加了getter/setter和toString方法。

7.String Manipulation

字符串日常开发中经常用到的，但是不同的字符串类型在不同的地方可能有一些不同的规则，比如类名要用驼峰形式、常量需要全部大写等，有时候还需要进行编码解码等。这里推荐一款强大的字符串转换工具——String Manipulation。

它强大到什么程度，看下他的功能列表你就知道了：

安装好插件后，选中需要处理的内容后，按快捷键Alt+m，即可d出工具功能列表。

很好很强大的一款字符串处理工具。

8.Mybatis plugin

目前ORM框架中，Mybatis非常受欢迎。但是，同时给很多开发带来困扰的就是Mybatis需要很多xml的配置文件，有的时候很难去进行修改。

这里推荐一款神器，可以让你像编辑java代码一样编辑mybatis的文件。

Intellij Idea Mybatis插件主要功能：

提供Mapper接口与配置文件中对应SQL的导航

编辑XML文件时自动补全

根据Mapper接口, 使用快捷键生成xml文件及SQL标签

ResultMap中的property支持自动补全，支持级联(属性A.属性B.属性C)

快捷键生成@Param注解

XML中编辑SQL时, 括号自动补全

XML中编辑SQL时, 支持参数自动补全(基于@Param注解识别参数)

自动检查Mapper XML文件中ID冲突

自动检查Mapper XML文件中错误的属性值

支持Find Usage

支持重构从命名

支持别名

自动生成ResultMap属性

（图源：https://www.oschina.net/p/intellij-mybatis-plugin）

但是这款插件是收费的，但是不影响他确实是一个很实用，可以很大程度上提升开发效率的插件。读者可以考虑使用Free Mybatis plugin（这款插件我没用过，具体是否好用有待考证）。

9.Key promoter X

对于很多刚刚开始使用IDEA的开发者来说，最苦恼的就是不知道快捷键 *** 作是什么。

使用IDEA，如果所有 *** 作都使用鼠标，那么说明你还不是一个合格的程序员。

这里推荐一款可以进行快捷键提示的插件Key promoter X。

Key Promoter X 是一个提示插件，当你在IDEA里面使用鼠标的时候，如果这个鼠标 *** 作是能够用快捷键替代的，那么Key Promoter X会d出一个提示框，告知你这个鼠标 *** 作可以用什么快捷键替代。

当我使用鼠标查看一个方法都被哪些类使用的时候，就会提示：

记住这个快捷键以后，就可以使用快捷键代替鼠标啦。

10.activate-power-mode

最后，介绍一款程序员很好的在妹子面前装X的插件——activate-power-mode 。

安装了这款插件之后，你写代码的时候，就会附加一些狂拽炫酷屌炸天的效果

11.ignore

git提交时过滤掉不需要提交的文件，很方便，有些本地文件是不需要提交到Git上的。

12.CamelCase

将不是驼峰格式的名称，快速转成驼峰格式，安装好后，选中要修改的名称，按快捷键shift+alt+u。

13.CodeGlance

在编辑区的右侧显示的代码地图。

14.Material Theme UI

这是一款主题插件，可以让你的ide的图标变漂亮，配色搭配的很到位，还可以切换不同的颜色，甚至可以自定义颜色。默认的配色就很漂亮了，如果需要修改配色，可以在工具栏中Tools->Material Theme然后修改配色等。

15.Background image Plus

这是一款可以设置idea背景图片的插件，不但可以设置固体的图片，还可以设置一段时间后随机变化背景图片，以及设置图片的透明度等等。

16.### Rainbow Brackets

彩虹颜色的括号 看着很舒服 敲代码效率变高

SpringBoot | 番外：使用小技巧合集

设置网站图标

原来我们在使用tomcat开发时，设置网站图片时，即icon图标时，一般都是直接替换root包下的favicon.ico替换成自己的，或者在网页的头部设置link的ref为icon然后设置其href值。而在SpringBoot中，替换图片也是很简单的，只需要将自定义图片放置在静态资源目录下即可，即默认有static、public、resources、/META-INF/resources或者自定义的静态目录下即可。

目录结构：

允许跨域访问

CORS是一个W3C标准，全称是”跨域资源共享”（Cross-origin resource sharing）。它允许浏览器向跨源(协议 + 域名 + 端口)服务器，发出XMLHttpRequest请求，从而克服了AJAX只能同源使用的限制。

简单来说，跨域问题是可以通过nginx来解决的，或者通过jsonp(只支持get请求)来解决。而SpringBoot中也提供了配置方法。

0.利用@CrossOrigin注解，可放至在类上或者方法上。类上代表整个控制层所有的映射方法都支持跨域请求。

@CrossOrigin(origins = "http://blog.lqdev.cn", maxAge = 3600) @RestController public class demoController{

@GetMapper("/")

public String index(){

return "hello,CORS"

} }

1.配置全局CORS配置。官网也有给出实例，具体如下：

@Configuration public class MyConfiguration {

@Bean

public WebMvcConfigurer corsConfigurer() {

return new WebMvcConfigurerAdapter() {

@Override

public void addCorsMappings(CorsRegistry registry) { registry.addMapping("/api/**").allowedOrigins("https://blog.lqdev.cn")

}

}

} }

独立Tomcat运行

讲解了这么久，一般上我们都是通过jar包的方式进行启动的应用的。所以部署在独立的tomcat时，需要如何解决呢？其实也简单，只需要将项目打包方式修改为war包，然后修改下启动类配置即可。

0.修改pom打包方式为war，同时排除了内置的tomcat。

<packaging>war</packaging> <!-- 排除内置的tomcat -->

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-tomcat</artifactId>

<scope>compile</scope>

</dependency> <!-- 若直接有使用servlet对象时(这是废话，⊙﹏⊙‖∣)，需要将servlet引入，本例是没有的~ -->

<dependency>

<groupId>javax.servlet</groupId>

<artifactId>javax.servlet-api</artifactId>

<scope>provided</scope>

</dependency>

1.改造下启动类，使其继承SpringBootServletInitializer,同时覆盖configure方法。

@SpringBootApplication @Slf4j public class ChapterApplication extends SpringBootServletInitializer{

public static void main(String[] args) {

SpringApplication.run(ChapterApplication.class, args)

// new SpringApplicationBuilder().sources(ChapterApplication.class).web(false).run(args)

//之后这里设置业务逻辑 比如挂起一个线程 或者设置一个定时任务。保证不退出

//不然它就是一个启动类，启动后就停止了。

log.info("jar,chapter启动!")

}  

@Override

protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {

log.info("外部tomcat,chapter启动!")

return application.sources(ChapterApplication.class)

} }

2.maven打包成war(mvn clean install),然后放入tomcat中，启动运行即可。

其实这样设置的话，在开发时直接运行启动类也还是可以直接运行的，方便.

启动不设置端口

对一些定时任务服务项目，其本身只是提供一个定时调度功能，不需要其他服务调用，只是去调度其他服务。像这样的服务，正常也就不需要设置端口了。这时候SpringBoot也是支持的。只需要改下启动方式：

new SpringApplicationBuilder().sources(ChapterApplication.class).web(false).run(args)

//之后这里设置业务逻辑 比如挂起一个线程 或者设置一个定时任务。保证不退出

//不然它就是一个启动类，启动后就停止了。

或者修改配置文件的属性：

spring.main.web-environment=fals

最后效果，是不是没有看见端口了：

启动完成前进行业务逻辑

利用CommandLineRunner或者ApplicationRunner可实现在SpringApplication的run()完成前执行一些业务逻辑

0.修改启动类，实现CommandLineRunner接口,ApplicationRunner类似，只是run的入参不同而已。

@Override

public void run(String... args) throws Exception {

log.info("CommandLineRunner运行")

}

运行应用，注意查看控制台输出：

当然，直接申明一个bean也是可以的。

rConfig {

@Bean

public CommandLineRunner runner(){

return new CommandLineRunner() {

public void run(String... args){

log.info("CommandLineRunner运行2")

}

}

}

}

若多个时，可设置@Order来确定执行的顺序。

动态修改日志级别

通过org.springframework.boot.logging.LoggingSystem提供的api即可。

loggingSystem.setLogLevel(null, LogLevel.DEBUG)

如，默认时是info模式，未修改时，debug模式是不会输出的。

动态设置后：

热部署

前面讲了这么多章节，因为功能都很单一，所以一般上都是直接重启服务来进行更新 *** 作。但当服务功能一多，启动速度缓慢时，还是配置个热部署比较方便。在SpringBoo中，只需要加入一个spring-boot-devtools即可。

<dependencies>

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-devtools</artifactId>

<optional>true</optional>

</dependency>

</dependencies>

题外话：这里的<optional>true</optional>是表示依赖不会传递，依赖了此项目的需要额外引入此包，若需要使用的话。

若不生效，可试着在打包工具spring-boot-maven-plugin下的configuration加入<fork>true</fork>看看，具体配置项如下：

<plugin>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-maven-plugin</artifactId>

<configuration>

<fork>true</fork>

</configuration>

</plugin>

自定义启动Banner

看烦了自带的Banner，动手修改一个属于自己的Banner，提现逼格的时候到了~哈哈，以下是官网给的配置指南：

文字形式

其实，替换很简单，只需要在classpath路径下创建一个banner.txt即可。具体的一些变量官网也有给出，具体如下：

现在我们就定制一个自己的Banner。

_ _ _ _ __ _  

| | | | | | | |/ / | |

| |__ ___ | | | | ___ ___ | ' / ___ _ __ __ _ | |

| '_  / _  | | | | / _  / _  | < / _  | '_  / _` | | |

| | | | | __/ | | | | | (_) | _ | (_) | | .  | (_) | | | | | | (_| | |_|

|_| |_| ___| |_| |_| ___/ ( ) ___/ |_|_ ___/ |_| |_| __, | (_)

|/ __/ |  

|___/  ${AnsiColor.BRIGHT_RED} Spring Boot Version: ${spring-boot.version}${spring-boot.formatted-version}

题外话：手输字符画是不太现实的，大家可通过一些网站进行快速生成。可自行搜索下，网上一搜一大把。

图片形式

若觉得使用文字不够酷炫，当然也可以将图片设置为启动的banner。目前支持的图片格式有gif、png、jpg。使用也很简单，只需要命名为banner即可。

如将头像放入目录中，最后的效果如下：

当然，若图片是有色彩的，也是可以的，对于太复杂的图片显示效果就不佳了，如下。

原图：

原图

banner效果图：

原图

banner效果图：

---