From 65a78631ea7f4d5d520370293c28ddf96c367653 Mon Sep 17 00:00:00 2001 From: Emily Kellison-Linn <4672118+emilykl@users.noreply.github.com> Date: Wed, 15 Jan 2025 16:50:39 -0500 Subject: [PATCH 1/5] copy over text from release.md in plotly.py --- release.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 release.md diff --git a/release.md b/release.md new file mode 100644 index 0000000..77ecab1 --- /dev/null +++ b/release.md @@ -0,0 +1,49 @@ +## Release process - `plotly-geo` package + +The `plotly-geo` package contains the shape file resources used by plotly.py. +These files are relatively large and change infrequently so it is useful +to release them in a separate package. + +### Update version + +Update the version of the `plotly-geo` package in +`packages/python/plotly-geo/setup.py`. + +This version is not intended to match the version of plotly.py. + +### Update CHANGELOG + +Add a new entry to the CHANGELOG at `packages/python/plotly-geo/CHANGELOG.md` +and commit the changes. + +### Tag Release + +Create a new tag for the release + +```bash +(plotly_dev) $ git checkout master +(plotly_dev) $ git stash +(plotly_dev) $ git pull origin master +(plotly_dev) $ git tag plotly-geo-vX.Y.Z +(plotly_dev) $ git push origin plotly-geo-vX.Y.Z +``` + +### Publishing to PYPI + +Publish the final version to PyPI + +```bash +(plotly_dev) $ cd packages/python/plotly-geo +(plotly_dev) $ python setup.py sdist bdist_wheel +(plotly_dev) $ twine upload dist/plotly-geo-X.Y.Z.tar.gz +(plotly_dev) $ twine upload dist/plotly_geo-X.Y.Z-py3-none-any.whl +``` + +### Publish to plotly anaconda channel + +From `packages/python/plotly-geo`, build the conda package +```bash +(plotly_dev) $ conda build recipe/ +``` + +Then upload to the plotly anaconda channel as described above \ No newline at end of file From 93190374c1ff278d20b4c1a373f6997fed44dd2b Mon Sep 17 00:00:00 2001 From: Emily Kellison-Linn <4672118+emilykl@users.noreply.github.com> Date: Wed, 15 Jan 2025 16:57:25 -0500 Subject: [PATCH 2/5] update paths, branch names, tags --- release.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/release.md b/release.md index 77ecab1..0a962d7 100644 --- a/release.md +++ b/release.md @@ -1,4 +1,4 @@ -## Release process - `plotly-geo` package +## Release process for `plotly-geo` package The `plotly-geo` package contains the shape file resources used by plotly.py. These files are relatively large and change infrequently so it is useful @@ -7,41 +7,40 @@ to release them in a separate package. ### Update version Update the version of the `plotly-geo` package in -`packages/python/plotly-geo/setup.py`. +`setup.py`. This version is not intended to match the version of plotly.py. ### Update CHANGELOG -Add a new entry to the CHANGELOG at `packages/python/plotly-geo/CHANGELOG.md` +Add a new entry to the CHANGELOG at `CHANGELOG.md` and commit the changes. ### Tag Release -Create a new tag for the release +Create a new tag for the release: ```bash -(plotly_dev) $ git checkout master +(plotly_dev) $ git checkout main (plotly_dev) $ git stash -(plotly_dev) $ git pull origin master -(plotly_dev) $ git tag plotly-geo-vX.Y.Z -(plotly_dev) $ git push origin plotly-geo-vX.Y.Z +(plotly_dev) $ git pull origin main +(plotly_dev) $ git tag vX.Y.Z +(plotly_dev) $ git push origin vX.Y.Z ``` ### Publishing to PYPI -Publish the final version to PyPI +Publish the final version to PyPI: ```bash -(plotly_dev) $ cd packages/python/plotly-geo (plotly_dev) $ python setup.py sdist bdist_wheel -(plotly_dev) $ twine upload dist/plotly-geo-X.Y.Z.tar.gz +(plotly_dev) $ twine upload dist/plotly_geo-X.Y.Z.tar.gz (plotly_dev) $ twine upload dist/plotly_geo-X.Y.Z-py3-none-any.whl ``` ### Publish to plotly anaconda channel -From `packages/python/plotly-geo`, build the conda package +From the repository's root directory, build the conda package: ```bash (plotly_dev) $ conda build recipe/ ``` From 4e214f2679e03e519231e9953c7cde871eef8e03 Mon Sep 17 00:00:00 2001 From: Emily Kellison-Linn <4672118+emilykl@users.noreply.github.com> Date: Wed, 15 Jan 2025 17:13:07 -0500 Subject: [PATCH 3/5] update year --- LICENSE.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE.txt b/LICENSE.txt index 359e5d3..2d78924 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2016-2019 Plotly, Inc +Copyright (c) 2016-2025 Plotly, Inc Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal From ea3bef02df511f0ab5370e0ad998906086eb5944 Mon Sep 17 00:00:00 2001 From: Emily Kellison-Linn <4672118+emilykl@users.noreply.github.com> Date: Wed, 15 Jan 2025 17:28:41 -0500 Subject: [PATCH 4/5] update URLs and tags --- setup.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/setup.py b/setup.py index b267556..2a3d5df 100644 --- a/setup.py +++ b/setup.py @@ -16,7 +16,7 @@ def readme(): maintainer="Jon Mease", maintainer_email="jon@plot.ly", url="https://plot.ly/python/", - project_urls={"Github": "https://github.com/plotly/plotly.py"}, + project_urls={"Github": "https://github.com/plotly/plotly-geo"}, description="geo shape files for use with plotly.py", long_description=readme(), long_description_content_type="text/markdown", @@ -28,6 +28,11 @@ def readme(): "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", "Topic :: Scientific/Engineering :: Visualization", ], license="MIT", From 0067abcccf6941733d07606eb4a89fe9ea5129e1 Mon Sep 17 00:00:00 2001 From: Emily KL <4672118+emilykl@users.noreply.github.com> Date: Tue, 28 Jan 2025 22:56:20 -0500 Subject: [PATCH 5/5] Update README.md Add short explanation in README about reorg --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a23077d..611b931 100644 --- a/README.md +++ b/README.md @@ -1 +1,3 @@ -Package containing the geo shape files used by plotly.py \ No newline at end of file +Package containing the geo shape files used by plotly.py + +_Note: plotly-geo was previously housed in the [Plotly.py](https://github.com/plotly/plotly.py) repository [until early 2025](https://github.com/plotly/plotly.py/pull/4972). This repository retains the Git history for all plotly-geo files, dating back to [mid-2019](https://github.com/plotly/plotly.py/pull/1604) when the Plotly.py directory structure was changed. If you want to follow the history of these files back further in time, start [here](https://github.com/plotly/plotly.py/commits/59e36cf850bdb2384ddaf40ac37ad79f691c610c/plotly-geo-package/README.md?browsing_rename_history=true&new_path=packages/python/plotly-geo/README.md&original_branch=master)._