Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Changelog

## 1.4.2

**Date** - 09/16/2020

**Release Tag** - [py1.4.2](https://github.com/datacommonsorg/api-python/releases/tag/py1.4.2)

**Release Status** - Current head of branch [`master`](https://github.com/datacommonsorg/api-python/tree/master)

New features added to the Python API

- Added batching to `get_stat_all` to handle querying for many StatisticalVariables across many Places.

## 1.4.1

**Date** - 08/25/2020
Expand Down
53 changes: 48 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,54 @@ $ python -m datacommons.examples.XXX

where XXX is the module you want to run.

## Release to PyPI

- Update "VERSION" in [setup_datacommons.py](setup_datacommons.py)
- Update [CHANGELOG.md](CHANGELOG.md) for a new version
- 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)
## Release

Note: Always release `datacommons_pandas` when `datacommons` is released.

**If this is your first time releasing to PyPI**, please review the PyPI guide
starting from the
[setup section](https://packaging.python.org/tutorials/packaging-projects/#creating-setup-py).

### Release to Test PyPI

1. In [setup_datacommons.py](setup_datacommons.py) and
[setup_datacommons_pandas.py](setup_datacommons_pandas.py):
- Append "-USERNAME" to the package "NAME". For example,
`NAME = 'foo_package-janedoe123'`.
- Increment the "VERSION" codes to something that has not been used in your
test project. This will not affect the production PyPI versioning.
1. Build the dists:
```bash
rm dist/*
python3 -m pip install --user --upgrade setuptools wheel
python3 setup_datacommons.py sdist bdist_wheel
python3 setup_datacommons_pandas.py sdist bdist_wheel
```
1. Release the dists to TestPyPI:
```bash
python3 -m pip install --user --upgrade twine
python3 -m twine upload --repository testpypi dist/*
```

### Release to Production PyPI
1. In [setup_datacommons.py](setup_datacommons.py) and
[setup_datacommons_pandas.py](setup_datacommons_pandas.py):
- Revert the package name to `datacommons` and `datacommons_pandas`
- Update and double check "VERSION"
1. Update [CHANGELOG.md](CHANGELOG.md) and
[datacommons_pandas/CHANGELOG.md](datacommons_pandas/CHANGELOG.md)
1. Build the dists:
```bash
rm dist/*
python3 -m pip install --user --upgrade setuptools wheel
python3 setup_datacommons.py sdist bdist_wheel
python3 setup_datacommons_pandas.py sdist bdist_wheel
```
1. Release the dists to PyPI:
```bash
python3 -m pip install --user --upgrade twine
twine upload dist/*
```

## Support

Expand Down
10 changes: 10 additions & 0 deletions datacommons_pandas/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Changelog

## 0.0.2

**Date** - 09/16/2020

**Release Tag** - [pd.0.0.2](https://github.com/datacommonsorg/api-python/releases/tag/pd0.0.2)

**Release Status** - Current head of branch [`master`](https://github.com/datacommonsorg/api-python/tree/master)

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.

## 0.0.1

**Date** - 08/25/2020
Expand Down
6 changes: 2 additions & 4 deletions datacommons_pandas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,9 @@ Apache 2.0

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

## Release to PyPI
## Release

- Update "VERSION" in [setup_datacommons_pandas.py](../setup_datacommons_pandas.py)
- Update [CHANGELOG.md](CHANGELOG.md) for a new version
- 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)
Please follow the [Release instructions](../README.md#release).

## Support

Expand Down
2 changes: 1 addition & 1 deletion setup_datacommons.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
EMAIL = 'support@datacommons.org'
AUTHOR = 'datacommons.org'
REQUIRES_PYTHON = '>=2.7'
VERSION = '1.4.1'
VERSION = '1.4.2'

REQUIRED = [
'six',
Expand Down
2 changes: 1 addition & 1 deletion setup_datacommons_pandas.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
EMAIL = 'support@datacommons.org'
AUTHOR = 'datacommons.org'
REQUIRES_PYTHON = '>=2.7'
VERSION = '0.0.1'
VERSION = '0.0.2'

REQUIRED = [
'six',
Expand Down