File: docs.md

package info (click to toggle)
azure-multiapi-storage-python 1.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 9,624 kB
  • sloc: python: 95,334; sh: 60; makefile: 2
file content (55 lines) | stat: -rw-r--r-- 1,553 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
### Packaging
Create the package (both source and whl) by running:
```
python setup.py sdist
python setup.py bdist_wheel
```

### Publishing

Modify the version number in `setup.py` and modify changelog in README.rst then create a pull request for the changes.

#### Release with Travis CI

Once the changes have been merged to master, create a tag on GitHub for that commit.
Follow the format of other releases in the release notes you create on GitHub.

A Travis CI build will be kicked-off that will publish to PyPI.

#### Release manually 

Once the changes have been merged to master, continue with the rest of the release.

```
git clone https://github.com/Azure/azure-multiapi-storage-python
cd azure-multiapi-storage-python
python setup.py sdist bdist_wheel
```

```
pip install twine
```

```
export TWINE_REPOSITORY_URL=https://upload.pypi.org/legacy/
export TWINE_USERNAME=A_USERNAME
export TWINE_PASSWORD=A_SECRET
twine upload dist/*
```

### Installing

Once wheel is created:
```
pip install <path-to-wheel>
```

### Handling changes to Storage SDK
When there are changes made in https://github.com/Azure/azure-storage-python, they should be added here also.

If the change is for a new API version, create the vYYYY_MM_DD directory and copy the code.  
Finally, replace the absolute imports to `azure.storage` to be relative.

If there is a change but the API version does not change, find the appropriate API version directory, delete the old code and replace.  
Finally, replace the absolute imports to `azure.storage` to be relative.