Skip to content

Updates for new repo #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 30, 2025
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
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Package containing the geo shape files used by plotly.py
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)._
48 changes: 48 additions & 0 deletions release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
## 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
to release them in a separate package.

### Update version

Update the version of the `plotly-geo` package in
`setup.py`.

This version is not intended to match the version of plotly.py.

### Update CHANGELOG

Add a new entry to the CHANGELOG at `CHANGELOG.md`
and commit the changes.

### Tag Release

Create a new tag for the release:

```bash
(plotly_dev) $ git checkout main
(plotly_dev) $ git stash
(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:

```bash
(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 the repository's root directory, build the conda package:
```bash
(plotly_dev) $ conda build recipe/
```

Then upload to the plotly anaconda channel as described above
7 changes: 6 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand Down