Skip to content

Commit 9a609ef

Browse files
tjanntjann
authored
Version bump for python and pandas API for get_stat_all batching. (datacommonsorg#158)
* Version bump for python and pandas API for get_stat_all batching. * Improve READMEs for PyPI flow.
1 parent 33013fb commit 9a609ef

File tree

6 files changed

+74
-11
lines changed

6 files changed

+74
-11
lines changed

‎CHANGELOG.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Changelog
22

3+
## 1.4.2
4+
5+
**Date** - 09/16/2020
6+
7+
**Release Tag** - [py1.4.2](https://github.com/datacommonsorg/api-python/releases/tag/py1.4.2)
8+
9+
**Release Status** - Current head of branch [`master`](https://github.com/datacommonsorg/api-python/tree/master)
10+
11+
New features added to the Python API
12+
13+
- Added batching to `get_stat_all` to handle querying for many StatisticalVariables across many Places.
14+
315
## 1.4.1
416

517
**Date** - 08/25/2020

‎README.md‎

Lines changed: 48 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,54 @@ $ python -m datacommons.examples.XXX
6666

6767
where XXX is the module you want to run.
6868

69-
## Release to PyPI
70-
71-
- Update "VERSION" in [setup_datacommons.py](setup_datacommons.py)
72-
- Update [CHANGELOG.md](CHANGELOG.md) for a new version
73-
- Upload a new package using steps for [generating distribution archives](https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives) and [uploading the distribution archives](https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives)
69+
## Release
70+
71+
Note: Always release `datacommons_pandas` when `datacommons` is released.
72+
73+
**If this is your first time releasing to PyPI**, please review the PyPI guide
74+
starting from the
75+
[setup section](https://packaging.python.org/tutorials/packaging-projects/#creating-setup-py).
76+
77+
### Release to Test PyPI
78+
79+
1. In [setup_datacommons.py](setup_datacommons.py) and
80+
[setup_datacommons_pandas.py](setup_datacommons_pandas.py):
81+
- Append "-USERNAME" to the package "NAME". For example,
82+
`NAME = 'foo_package-janedoe123'`.
83+
- Increment the "VERSION" codes to something that has not been used in your
84+
test project. This will not affect the production PyPI versioning.
85+
1. Build the dists:
86+
```bash
87+
rm dist/*
88+
python3 -m pip install --user --upgrade setuptools wheel
89+
python3 setup_datacommons.py sdist bdist_wheel
90+
python3 setup_datacommons_pandas.py sdist bdist_wheel
91+
```
92+
1. Release the dists to TestPyPI:
93+
```bash
94+
python3 -m pip install --user --upgrade twine
95+
python3 -m twine upload --repository testpypi dist/*
96+
```
97+
98+
### Release to Production PyPI
99+
1. In [setup_datacommons.py](setup_datacommons.py) and
100+
[setup_datacommons_pandas.py](setup_datacommons_pandas.py):
101+
- Revert the package name to `datacommons` and `datacommons_pandas`
102+
- Update and double check "VERSION"
103+
1. Update [CHANGELOG.md](CHANGELOG.md) and
104+
[datacommons_pandas/CHANGELOG.md](datacommons_pandas/CHANGELOG.md)
105+
1. Build the dists:
106+
```bash
107+
rm dist/*
108+
python3 -m pip install --user --upgrade setuptools wheel
109+
python3 setup_datacommons.py sdist bdist_wheel
110+
python3 setup_datacommons_pandas.py sdist bdist_wheel
111+
```
112+
1. Release the dists to PyPI:
113+
```bash
114+
python3 -m pip install --user --upgrade twine
115+
twine upload dist/*
116+
```
74117

75118
## Support
76119

‎datacommons_pandas/CHANGELOG.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Changelog
22

3+
## 0.0.2
4+
5+
**Date** - 09/16/2020
6+
7+
**Release Tag** - [pd.0.0.2](https://github.com/datacommonsorg/api-python/releases/tag/pd0.0.2)
8+
9+
**Release Status** - Current head of branch [`master`](https://github.com/datacommonsorg/api-python/tree/master)
10+
11+
Update to use datacommons Python API 1.4.2, which adds batching to the get_stat_all function used by build_time_series_dataframe and build_multivariate_dataframe.
12+
313
## 0.0.1
414

515
**Date** - 08/25/2020

‎datacommons_pandas/README.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,9 @@ Apache 2.0
3333

3434
Please follow the [Development instructions](../README.md#development).
3535

36-
## Release to PyPI
36+
## Release
3737

38-
- Update "VERSION" in [setup_datacommons_pandas.py](../setup_datacommons_pandas.py)
39-
- Update [CHANGELOG.md](CHANGELOG.md) for a new version
40-
- Upload a new package using steps for [generating distribution archives](https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives) and [uploading the distribution archives](https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives)
38+
Please follow the [Release instructions](../README.md#release).
4139

4240
## Support
4341

‎setup_datacommons.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
EMAIL = '[email protected]'
2525
AUTHOR = 'datacommons.org'
2626
REQUIRES_PYTHON = '>=2.7'
27-
VERSION = '1.4.1'
27+
VERSION = '1.4.2'
2828

2929
REQUIRED = [
3030
'six',

‎setup_datacommons_pandas.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
EMAIL = '[email protected]'
2525
AUTHOR = 'datacommons.org'
2626
REQUIRES_PYTHON = '>=2.7'
27-
VERSION = '0.0.1'
27+
VERSION = '0.0.2'
2828

2929
REQUIRED = [
3030
'six',

0 commit comments

Comments
 (0)