Atlassian Python API 使用教程

1. 项目的目录结构及介绍

atlassian-python-api/
├── atlassian/
│   ├── __init__.py
│   ├── jira.py
│   ├── confluence.py
│   ├── bitbucket.py
│   ├── crowd.py
│   ├── servicedesk.py
│   ├── xray.py
│   └── ...
├── examples/
│   ├── jira_example.py
│   ├── confluence_example.py
│   ├── bitbucket_example.py
│   └── ...
├── tests/
│   ├── test_jira.py
│   ├── test_confluence.py
│   ├── test_bitbucket.py
│   └── ...
├── setup.py
├── requirements.txt
├── README.md
└── ...

目录结构介绍

• atlassian/: 包含与 Atlassian 产品交互的核心模块，如 Jira、Confluence、Bitbucket 等。
• examples/: 包含各种示例代码，展示如何使用该库与 Atlassian 产品进行交互。
• tests/: 包含测试代码，确保库的各个部分正常工作。
• setup.py: 用于安装该库的脚本。
• requirements.txt: 列出了运行该库所需的所有依赖项。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件通常是 setup.py，它负责安装和配置项目。以下是 setup.py 的基本内容：

from setuptools import setup, find_packages

setup(
    name='atlassian-python-api',
    version='3.41.14',
    packages=find_packages(),
    install_requires=[
        'requests>=2.25.1',
        'six>=1.15.0',
        'oauthlib>=3.1.0',
        'requests-oauthlib>=1.3.0'
    ],
    url='https://github.com/atlassian-api/atlassian-python-api',
    license='Apache License 2.0',
    author='AstroMatt',
    author_email='[e-mail]',
    description='Python Atlassian REST API Wrapper',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    classifiers=[
        'Development Status :: 5 - Production/Stable',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: Apache Software License',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: 3.9',
    ],
)

启动文件介绍

• name: 项目名称。
• version: 项目版本。
• packages: 需要包含的包。
• install_requires: 项目依赖的其他库。
• url: 项目的主页。
• license: 项目使用的许可证。
• author: 项目作者。
• author_email: 作者的电子邮件。
• description: 项目的简短描述。
• long_description: 项目的详细描述，通常从 README.md 文件中读取。
• classifiers: 项目的分类信息。

3. 项目的配置文件介绍

项目通常没有单独的配置文件，而是通过代码中的参数进行配置。以下是一个配置示例：

from atlassian import Jira
from atlassian import Confluence

jira = Jira(
    url='http://localhost:8080',
    username='admin',
    password='admin'
)

confluence = Confluence(
    url='http://localhost:8090',
    username='admin',
    password='admin'
)

配置文件介绍

• url: Atlassian 产品的 URL。
• username: 用于认证的用户名。
• password: 用于认证的密码。

通过这种方式，您可以配置与 Jira、Confluence 等产品的连接。