首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

在PyPi中创建Python包时,如何指定自述文件的路径

在PyPi中创建Python包时,可以通过在项目根目录下创建一个名为README.md的文件来指定自述文件的路径。README.md文件通常用于提供项目的说明、使用方法、示例代码等信息。

README.md文件中,可以使用Markdown语法编写文档内容,包括标题、段落、列表、代码块等。可以在文件中添加项目的介绍、安装方法、使用示例、API文档等相关信息,以便其他开发者了解和使用你的Python包。

在PyPi中发布Python包时,需要在项目的setup.py文件中指定自述文件的路径。可以通过long_description参数来指定自述文件的路径,例如:

代码语言:txt
复制
from setuptools import setup

setup(
    name='your-package',
    version='1.0',
    description='Your package description',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    url='https://github.com/your-username/your-package',
    packages=['your_package'],
    install_requires=[
        'dependency1',
        'dependency2',
    ],
)

在上述示例中,long_description参数的值为open('README.md').read(),表示读取项目根目录下的README.md文件作为自述文件的内容。同时,通过long_description_content_type参数指定自述文件的内容类型为Markdown。

推荐的腾讯云相关产品:腾讯云对象存储(COS),用于存储和管理Python包的相关文件。详情请参考腾讯云对象存储(COS)

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

教你几分钟内构建一个Python

1 前言 构建过程有些复杂,但从长远来看是值得,尤其是可以创建属于自己Python。...本文目的是通过对构建一个新发行包案例研究,让您了解需要构建什么以及如何构建python基础知识。 ? 2 开始 首先,您肯定需要设置一个或多个内容,以便了解如何构建python。...注意:b_dist是一个文件夹,setup.py带有自述文件。md不在b_dist文件夹。...当您在python程序中导入一个,剩余__init__文件就会运行。在这种情况下,其他__init__文件导入高斯、二项和分布模型,以便在使用直接导入这些类。...首先,用测试创建一个帐户。对两个站点使用相同用户名和密码。 ? 成功创建两个帐户之后,让我们返回IDE并将包上传到TestPyPi。

53530

如何解决DLL入口函数创建或结束线程卡死

先看一下使用Delphi开发DLL如何使用MAIN函数, 通常情况下并不会使用到DLLMAIN函数,因为delphi框架已经把Main函数隐藏起来 而工程函数 begin end 默认就是MAIN...以上都是题外话,本文主要说明DLL入口函数里面创建和退出线程为什么卡死和如何解决问题。...1) DLL_PROCESS_ATTACH 事件 创建线程 出现卡死问题 通常情况下在这事件仅仅是创建并唤醒线程,是不会卡死,但如果同时有等待线程正式执行代码,则会卡死,因为该事件...解决办法同样是避免 DLL_PROCESS_DETACH事件结束线程,那么我们可以该事件创建并唤醒另外一个线程,该新线程里,结束需要结束线程,并在完成后结束自身即可。...提醒: 标准做法还是建议遵循MS规则,不要在DLL入口函数做线程相关创建和释放操作。 总体上代码如下: ?

3.8K10
  • Python官方库软件SSH-Decorator被植入后门

    据 Reddit 用户报告, PythonSSH-Decorator 软件中发现了窃取用户 SSH 私钥及帐号密码后门,目前该库已被Python官方移除。...软件植入。...Uri Goren还说: “我已经更新了我PyPI密码,并重新转发上传了一个新SSH-Decorator。另外,我还在软件自述文件作了说明,确保用户知晓此事。”...SSH-Decorator后续给出自述文件是这样说明: 此次后门事件已引起我们高度重视,主要原因在于之前版本SSH-Decorator软件包被黑客非法劫持并向其中植入了恶意后门,导致从PyPi下载该软件用户受到影响...与此次Python第三方库PyPI出现SSH-Decorator后门事件类似,2017年,斯洛伐克国家安全办公室也曾发现,PyPI存在十余款恶意Python软件,之后,这些软件包被Python

    76870

    制作跨平台 NuGet 工具如何将工具(exedll)所有依赖一并放入

    制作跨平台 NuGet 工具如何将工具(exe/dll)所有依赖一并放入 2018-07-03 13:30 NuGet 提供了工具类型支持...本文将介绍将这些依赖加入 NuGet 方法,使得复杂工具能够正常使用。...---- 问题 你可能是 创建一个基于命令行工具跨平台 NuGet 工具 时候遇到依赖问题,也可能是自己做到另外什么工具遇到。...太早了依赖文件还没有生成,太晚了 NuGet 即将打的文件早已确认,Include 了也没用。...然后,我们就可以把输出目录除了 NuGet 自然而然会帮我们打入 NuGet 所有文件都加入到 NuGet 对应目录下。 具体来说,是将下面的 Target 添加到项目文件末尾。

    2.8K30

    Windows安装和配置Python及pip.ini文件配置

    命令行输入Python,正确显示Python版本,即表示Python安装成功 如果在命令行输入python出现如下错误 可能是因为安装Python过程没有勾选 Add Python...右键此电脑 --> 选择 属性 选择高级系统设置–>环境变量–>找到并且双击Path 双击Path,弹框里点击新建,找到Python安装目录,把路径添加进去 这里新添加路径...安装 安装Python,会自动下载并且安装pip. 配置 windows命令行里,输入 pip -V 可以查看pip版本。...如果在命令行里,运行pip -V,出现如下提示: 可能是因为安装python过程未勾选 Add Python 3.7 to PATH 选项,需要手动配置pip环境变量。...使用pip管理Python pip install 安装指定 pip uninstall 删除指定 pip list 显示已经安装 pip freeze 显示已经安装

    3.4K10

    Python包管理必备–pip命令&设置镜像源

    近期周围很多朋友询问,Python如何管理和模块,并且很多常用使用pip安装时候,总是因为网络问题中断,在学习新造成了很大挫败感,这些问题也是之前自己在学习过程,遇到痛点,所以抽出精力...Python语言核心能快速上手并且极具吸引力是其异常丰富和强大,这些包给我们封装好了日常工作遇到问题或需求各种解决方案,所以python基础知识较为牢固,遇到具体问题,具体学习对应即可...,都是指定虚拟环境内完成,该环境只会安装项目依赖。...以下将展示如何修改pip和python默认版本,主要是修改.bash_profile配置文件,该文件主要用于配置用户级环境变量,和Python相关,包括搜索模块路径等变量,均在该文件内进行配置。...ESC :wq source ~/.bash_profile 二、pip镜像安装 使用pip进行安装时候,一般访问pypi服务器,找寻相关并自动下载安装,但在国内,一旦某相对较大,有极大可能会出现安装过程因网络原因导致下载中断等问题

    3.5K20

    如何打包和发布Python程序

    如何打包和发布Python程序 使用Python过程,我们经常需要做一件事情就是通过pip来安装第三方。那么你是否也曾想过pip安装是怎么被打包并发布上去呢?...具体步骤为: 新建一个目录作为根目录 把功能模块以Python形式放入根目录 根目录创建setup.py文件,并填写相应内容 根目录创建其它描述文件,如:LISENCE,README等 这里以...=[], # 安装复制到PATH路径脚本文件 entry_points={ 'console_scripts': [ # 配置生成命令行工具及入口...packages:需要打包Python目录;注意如果有子则必须显式列出来,如:pytestreport.api data_files:需要打包非.py文件; entry_points:指定安装之后程序入口脚本...PYPI Projects 安装完成之后,则需要测试下安装是否能正常工作,指定入口脚本是否安装并正常使用,如果一切正常那么恭喜你了发布到正式PYPI服务了!

    2.2K50

    Python程序打包指南:手把手教你一步步完成

    最近感兴趣想将开发项目转成Package,研究了一下相关文章,并且自己跑通了,走了一下弯路,这里记录一下如何打包一个简单Python项目,展示如何添加必要文件和结构来创建如何构建,以及如何将其上传到...构建后端决定您项目将如何指定其配置,包括元数据(有关项目的信息,例如,PyPI上显示名称和标签)和输入文件。...前端应该在构建自动安装它们。前端通常在隔离环境运行构建,因此在这里省略依赖项可能会导致构建错误。这应该始终包括后端,并且可能有其他构建依赖项。...description是对包装简短一句话总结。 readme是包含详细描述文件路径。这显示PyPI详细信息页面上。...当准备好将真实包上传到Python索引,可以像本教程中一样执行相同操作,但有以下重要区别: 为选择一个难忘且独特名称; https://pypi.org上注册一个帐户,这是两个独立服务器,

    1.8K20

    详解Python当中pip常用命令!

    安装 当然Python 3.4版本之后以及Python 2.7.9版本之后,官网安装当中就已经自带了pip,用户直接在安装完Python之后就可以直接使用,要是使用由virtualenv或者pyvenv...创建虚拟环境,那么pip也是被默认安装 如果是需要自己另外安装pip已经配置好Python环境当中运行下面这个命令行 py -m ensurepip --upgrade 另外一种方式是从官网上...(https://bootstrap.pypa.io/get-pip.py)直接下载get-pip.py脚本,然后直接运行python get-pip.py脚本即可 如何使用 安装后,命令行输入pip.../  豆瓣:http://pypi.douban.com/simple/ 下载但是不安装 要是我们想要下载某个指定路径下,命令行如下 pip download package_name -d "...就是在当前目录下下载requests模块以及其他所要依赖模块 批量安装软件 我们一般在看到别人项目,都会包含一个requirements.txt文件,里面包含了一些Python项目当中需要用到第三方库

    46420

    Python pip 常用命令

    安装 当然Python 3.4版本之后以及Python 2.7.9版本之后,官网安装当中就已经自带了pip,用户直接在安装完Python之后就可以直接使用,要是使用由virtualenv或者pyvenv...创建虚拟环境,那么pip也是被默认安装 如果是需要自己另外安装pip已经配置好Python环境当中运行下面这个命令行 py -m ensurepip --upgrade 另外一种方式是从官网上...(https://bootstrap.pypa.io/get-pip.py)直接下载get-pip.py脚本,然后直接运行python get-pip.py脚本即可 如何使用 安装后,命令行输入pip...要是我们想要下载某个指定路径下,命令行如下 pip download package_name -d "某个路径" 例如 pip download requests -d "."...就是在当前目录下下载requests模块以及其他所要依赖模块 批量安装软件 我们一般在看到别人项目,都会包含一个requirements.txt文件,里面包含了一些Python项目当中需要用到第三方库

    30040

    Python虚拟环境(pipenv、venv、conda一网打尽)

    这个主要归功于配置系统环境变量PATH,当我们命令行运行程序时,系统会根据PATH配置路径列表依次查寻是否有可执行文件pythonwindows,省略了后缀.exe),当查寻到该文件,执行该文件...使用pip安装,会发现在安装时候会安装其它依赖,但当我们用pip移除一个,却只移除了指定 为了解决上面的问题,python使用了虚拟环境这个概念,你可以认为是python环境多个副本...--pypi-mirror 指定安装源 --site-packages / --no-site-packages 是否使用python基础环境site-packages路径 查看虚拟环境相关信息...虚拟环境本质 虚拟环境本质就是修改了sys.path值,下面分别查看在虚拟环境和不在虚拟环境sys.path值 主要区别在于第三方路径,一个用是虚拟环境site-packages...创建pycharm工程,记得指定python解释器为虚拟环境Scripts目录下python.exe即可 发布者:全栈程序员栈长,转载请注明出处:https://javaforall.cn/175522

    29.5K53

    详解Python当中pip常用命令

    安装 当然Python 3.4版本之后以及Python 2.7.9版本之后,官网安装当中就已经自带了pip,用户直接在安装完Python之后就可以直接使用,要是使用由virtualenv或者pyvenv...创建虚拟环境,那么pip也是被默认安装 如果是需要自己另外安装pip已经配置好Python环境当中运行下面这个命令行 py -m ensurepip --upgrade 另外一种方式是从官网上...(https://bootstrap.pypa.io/get-pip.py)直接下载get-pip.py脚本,然后直接运行python get-pip.py脚本即可 如何使用 安装后,命令行输入pip.../ 豆瓣:http://pypi.douban.com/simple/ 下载但是不安装 要是我们想要下载某个指定路径下,命令行如下 pip download package_name -d "...就是在当前目录下下载requests模块以及其他所要依赖模块 批量安装软件 我们一般在看到别人项目,都会包含一个requirements.txt文件,里面包含了一些Python项目当中需要用到第三方库

    44910

    anaconda安装pycharm_anaconda和pycharm关联

    方式一:使用pip命令窗口(cmd)安装 注意:这种情况下要确保Anaconda路径已经添加到系统环境变量,否则有可能识别不了安装命令 1.1 安装 ①点击win+r输入cmd调出命令窗口来:...,这很有可能是你没有安装到当前工程文件使用环境,这也是为什么推荐使用Anaconda原因,它可以创建指定python版本环境,安装python把对应环境激活即可正常安装调用。...--trusted-host pypi.douban.com 下面举个例子: 【创建pytorch环境安装seaborn】 步骤如下: 首先:如图所示,点击Anaconda prompt...,等待之后输入【y】表示同意就可以了,这样你就创建了自己指定环境名和python版本号环境了,Anaconda安装文件下【envs】文件夹里就能看到自己有哪些环境了 可以看到这个就是刚刚创建...pytorch环境了,如果在pycharm编程想要使用这个环境,重复【二】步骤,步骤【⑥】中选择Anaconda—>envs—>pytorch—>python.exe就切换到pytorch环境下

    1.7K40

    Pipenv – 超好用 Pytho

    它能够自动为项目创建和管理虚拟环境,从 Pipfile 文件添加或者删除,同时生成 Pipfile.lock 文件来锁定安装版本和依赖信息,避免构建错误。...随时查看图形化依赖关系。 安装 pipenv 由于我开发环境一直都是 Mac 笔记本,所以这里只介绍 Mac 环境如何安装好了。...TEXT 指定某个Python版本作为虚拟环境安装源 --site-packages 附带安装原Python解释器第三方库 --jumbotron An easter...安装指定版本: pipenv install urllib3==1.22 安装开发环境下: 加 --dev 表示包括 Pipfile dev-packages 依赖。...pipenv lock 环境变量管理 如果你开发调试需要配一堆环境变量,可以写到 .env 文件 pipenv shell 进入虚拟环境,它会帮你把这些环境变量加载好,非常方便。

    1.4K20

    PyCharm+Pipenv虚拟环境开发和依赖管理教程详解

    Python版本) --python TEXT 指定某个Python版本作为虚拟环境安装源 --site-packages 附带安装原Python解释器第三方库 --jumbotron An...run 虚拟环境运行命令 shell 进入虚拟环境 uninstall 卸载一个库 update 卸载当前所有的,并安装它们最新版本 基本使用 我们可以创建一个项目,名称 PipenvTest...Python3 虚拟环境,–-three 代表创建一个 Python3 版本虚拟环境,–-python 则可以指定特定 Python 版本,当然如果指定了 –two 或者 –three 选项参数,...安装指定软件: $ pipenv install urllib3==1.22 安装开发环境下: 通常有一些Python只在你开发环境需要,而不是在生产环境,例如单元测试。...选择Pipenv 虚拟环境 Base interpreter为本机系统python解释器路径 Pipenv executable表示pipenv,命令环境变量路径 ?

    3.1K40

    使用pypi-server搭建简单PyPI

    pypiserver 是一个最基本PyPI服务器实现, 可以用来上传和维护Python. 本文介绍 pypiserver Ubuntu上基本安装, 配置和使用. 1....~/packages 来保存Python, 同时监听8080端口来提供PyPI服务. 1.2 上传Python 此时, 创建 ~/packages 目录后, 可以将Python包上传到此目录下...._demo-0.0.1.tar.gz_ 1.3.1 pip 本地环境, 可以使用 pip index-url 参数来访问 pypiserver 上Python: # pip search...上述命令-P参数用来指定密码文件, -a用来指定需要密码保护操作. 当这两个参数同时指定为., 表示所有的操作都不需要密码保护....具体-a参数使用可以查阅_pypiserver_启动命令帮助, 这里不再展开. pypi-server -P /root/.pypipasswd 接下来, 需要上传Python系统, 需要配置

    1.6K20

    如何制作whl文件「建议收藏」

    distutils和setuptools工具 用来Python环境构建和安装额外模块,模块可以基于Python,也可以C/C++写扩展模块,可以是python包含了C和Python编写模块...以上版本,64 位平台则适用于 Python 2.4 以上版本),可以让程序员更方便创建和发布 Python ,特别是那些对其它具有依赖性状况。...如果目录名是相对路径,则是相对于sys.prefix或sys.exec_prefix路径。如果没有提供模板,会被添加到MANIFEST文件。...upload dist/* 制作python为wheel文件 wheel是一个已经编译好安装不需要编译过程,安装whl文件要比发布源文件安装要快。... 修改setup.py版本号,然后直接上传即可 参考: wheel和egg不同 怎样将自己写传达到PyPi 发布你自己轮子 – PyPI打包上传实践 PyPI官网上传包教程 发布者

    2.9K10

    使用pypi-server搭建简单PyPI

    pypiserver 是一个最基本PyPI服务器实现, 可以用来上传和维护python. 本文介绍 pypiserver ubuntu上基本安装, 配置和使用. 1....~/packages 来保存Python, 同时监听8080端口来提供PyPI服务. 1.2 上传Python 此时, 创建 ~/packages 目录后, 可以将Python包上传到此目录下....上述命令-P参数用来指定密码文件, -a用来指定需要密码保护操作. 当这两个参数同时指定为., 表示所有的操作都不需要密码保护....具体-a参数使用可以查阅pypiserver启动命令帮助, 这里不再展开. pypi-server -P /root/.pypipasswd 接下来, 需要上传Python系统, 需要配置...接下来, 当我们向名为 localhost 或者地址为 http://localhost:8080 PyPI源上传Python, 用户名 sam 和密码 123456 就会被用来验证操作权限: python

    3.5K20
    领券