Updated Azure packaging (markdown)
Laurent Mazuel
Родитель
4de47c4cae
Коммит
c2a8428df3
|
|
@ -1,3 +1,144 @@
|
|||
This article describes how to declare setup.py and all packaging information for packages inside the "azure" namespace
|
||||
|
||||
Article to be written, please poke me lmazuel if urgent.
|
||||
Namespace packaging is complicated in Python, here's a few reading if you still doubt it:
|
||||
- https://packaging.python.org/guides/packaging-namespace-packages/
|
||||
- https://www.python.org/dev/peps/pep-0420/
|
||||
- https://github.com/pypa/sample-namespace-packages
|
||||
|
||||
This articles describes the recommendation on how to do it if you want to release a package inside the "azure" namespace. Being inside the "azure" namespace meaning you have a service "myservice" that you want to import using:
|
||||
```python
|
||||
import azure.myservice
|
||||
```
|
||||
|
||||
Notes:
|
||||
- This article is not about setup.py or setup.cfg or the right way to *write* the packaging, it's about what instructions you should use to achieve this. If you are fluent in setuptools, and prefer to write the suggestions in setup.cfg and not in setup.py, this is not a concern.
|
||||
|
||||
# What are the constraints?
|
||||
|
||||
We want to build sdist and wheels in order to follow the following constraints:
|
||||
- Solution should work with *decent* versions of pip and setuptools (not the very latest only, but not archaeology either)
|
||||
- Wheels must work with Python 2.7 and 3.4+
|
||||
- easy-install scenario is a plus, but cannot be considered critical anymore
|
||||
- mixed dev installation and PyPI installation should be explicitly addressed
|
||||
|
||||
# What do I do in my files to achieve that
|
||||
|
||||
The minimal files to have:
|
||||
- azure/\_\_init\_\_.py
|
||||
- MANIFEST.in
|
||||
- setup.py
|
||||
|
||||
The file "azure/\_\_init\_\_.py" must contain exactly this:
|
||||
```python
|
||||
__path__ = __import__('pkgutil').extend_path(__path__, __name__)
|
||||
```
|
||||
|
||||
Your MANIFEST.in must include the following line `include azure/__init__.py`.
|
||||
|
||||
Example:
|
||||
```shell
|
||||
include *.rst
|
||||
include azure/__init__.py
|
||||
```
|
||||
In your setup.py:
|
||||
|
||||
The "packages" section MUST EXCLUDE the "azure" package. Example:
|
||||
```python
|
||||
packages=find_packages(exclude=[
|
||||
'tests',
|
||||
# Exclude packages that will be covered by PEP420 or nspkg
|
||||
'azure',
|
||||
]),
|
||||
```
|
||||
|
||||
The "extras_requires" section MUST include a conditional dependency on "azure-nspkg" for Python 2. Example:
|
||||
|
||||
```python
|
||||
extras_require={
|
||||
":python_version<'3.0'": ['azure-mgmt-nspkg'],
|
||||
}
|
||||
```
|
||||
|
||||
Example of a full setup.py
|
||||
```python
|
||||
#!/usr/bin/env python
|
||||
|
||||
#-------------------------------------------------------------------------
|
||||
# Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
# Licensed under the MIT License. See License.txt in the project root for
|
||||
# license information.
|
||||
#--------------------------------------------------------------------------
|
||||
|
||||
import re
|
||||
import os.path
|
||||
from io import open
|
||||
from setuptools import find_packages, setup
|
||||
|
||||
# Change the PACKAGE_NAME only to change folder and different name
|
||||
PACKAGE_NAME = "azure-mgmt-compute"
|
||||
PACKAGE_PPRINT_NAME = "Compute Management"
|
||||
|
||||
# a-b-c => a/b/c
|
||||
package_folder_path = PACKAGE_NAME.replace('-', '/')
|
||||
# a-b-c => a.b.c
|
||||
namespace_name = PACKAGE_NAME.replace('-', '.')
|
||||
|
||||
# Version extraction inspired from 'requests'
|
||||
with open(os.path.join(package_folder_path, 'version.py'), 'r') as fd:
|
||||
version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]',
|
||||
fd.read(), re.MULTILINE).group(1)
|
||||
|
||||
if not version:
|
||||
raise RuntimeError('Cannot find version information')
|
||||
|
||||
with open('README.rst', encoding='utf-8') as f:
|
||||
readme = f.read()
|
||||
with open('HISTORY.rst', encoding='utf-8') as f:
|
||||
history = f.read()
|
||||
|
||||
setup(
|
||||
name=PACKAGE_NAME,
|
||||
version=version,
|
||||
description='Microsoft Azure {} Client Library for Python'.format(PACKAGE_PPRINT_NAME),
|
||||
long_description=readme + '\n\n' + history,
|
||||
license='MIT License',
|
||||
author='Microsoft Corporation',
|
||||
author_email='azpysdkhelp@microsoft.com',
|
||||
url='https://github.com/Azure/azure-sdk-for-python',
|
||||
classifiers=[
|
||||
'Development Status :: 5 - Production/Stable',
|
||||
'Programming Language :: Python',
|
||||
'Programming Language :: Python :: 2',
|
||||
'Programming Language :: Python :: 2.7',
|
||||
'Programming Language :: Python :: 3',
|
||||
'Programming Language :: Python :: 3.4',
|
||||
'Programming Language :: Python :: 3.5',
|
||||
'Programming Language :: Python :: 3.6',
|
||||
'Programming Language :: Python :: 3.7',
|
||||
'License :: OSI Approved :: MIT License',
|
||||
],
|
||||
zip_safe=False,
|
||||
packages=find_packages(exclude=[
|
||||
'tests',
|
||||
# Exclude packages that will be covered by PEP420 or nspkg
|
||||
'azure',
|
||||
'azure.mgmt',
|
||||
]),
|
||||
install_requires=[
|
||||
'msrest>=0.5.0',
|
||||
'msrestazure>=0.4.32,<2.0.0',
|
||||
'azure-common~=1.1',
|
||||
],
|
||||
extras_require={
|
||||
":python_version<'3.0'": ['azure-mgmt-nspkg'],
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
This syntax works with setuptools >= 17.1 and pip >= 6.0, which is considered enough to support in 2019.
|
||||
|
||||
# How can I check if my packages are built correctly?
|
||||
|
||||
- wheels does NOT contain a `azure/__init__.py` file (you can open it with a zip util)
|
||||
- wheels installs `azure-nskpg` ONLY on Python 2.
|
||||
- sdist must contains a `azure/__init__.py` file that declares the "azure" as a namespace package using the `pkgutil` syntax
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче