├── .github └── workflows │ └── push.yml ├── .gitignore ├── LICENSE ├── README.md ├── cookiecutter.json ├── input-for-demo.txt └── {{cookiecutter.old_package_name}} ├── README.md └── setup.py /.github/workflows/push.yml: -------------------------------------------------------------------------------- 1 | name: Update demo 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | 8 | jobs: 9 | update_demo: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - name: Checkout this repo 13 | uses: actions/checkout@v2 14 | with: 15 | path: main 16 | - name: Checkout pypi-rename-demo 17 | uses: actions/checkout@v2 18 | with: 19 | repository: simonw/pypi-rename-demo 20 | path: pypi-rename-demo-current 21 | token: ${{ secrets.PERSONAL_ACCESS_TOKEN_FOR_PUSH }} 22 | - name: Set up Python 23 | uses: actions/setup-python@v2 24 | with: 25 | python-version: 3.8 26 | - uses: actions/cache@v2 27 | name: Configure pip caching 28 | with: 29 | path: ~/.cache/pip 30 | key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }} 31 | restore-keys: | 32 | ${{ runner.os }}-pip- 33 | - name: Install dependencies 34 | run: | 35 | pip install cookiecutter 36 | - name: Build demo from template 37 | run: |- 38 | cat main/input-for-demo.txt | cookiecutter main 39 | find ~/work/ 40 | - name: Push to git 41 | env: 42 | PERSONAL_ACCESS_TOKEN_FOR_PUSH: ${{ secrets.PERSONAL_ACCESS_TOKEN_FOR_PUSH }} 43 | run: |- 44 | ls -lah /home/runner/work/pypi-rename/pypi-rename/datasette-insert-api 45 | # Move the .git folder across 46 | mv /home/runner/work/pypi-rename/pypi-rename/pypi-rename-demo-current/.git /home/runner/work/pypi-rename/pypi-rename/datasette-insert-api 47 | # Commit and push the changes 48 | cd /home/runner/work/pypi-rename/pypi-rename/datasette-insert-api 49 | git status 50 | git config user.name "Automated" 51 | git config user.email "actions@users.noreply.github.com" 52 | git add -A . 53 | git commit -m "Demo of pypi-rename ${GITHUB_SHA}" || exit 0 54 | git push -u origin main 55 | - name: Post commit comment 56 | run: |- 57 | cd /home/runner/work/pypi-rename/pypi-rename/datasette-insert-api 58 | export FULL_SHA=$(git rev-parse HEAD) 59 | export SHORT_SHA=${FULL_SHA::8} 60 | export NEWLINE=$'\n' 61 | echo '{}' | jq --arg v "Demo: https://github.com/simonw/pypi-rename-demo/tree/$SHORT_SHA" \ 62 | '. + { body: $v }' | \ 63 | curl -sL -X POST -d @- \ 64 | -H "Content-Type: application/json" \ 65 | -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \ 66 | "https://api.github.com/repos/$GITHUB_REPOSITORY/commits/$GITHUB_SHA/comments" 67 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | auth.json 2 | .DS_Store 3 | .venv 4 | __pycache__/ 5 | *.py[cod] 6 | *$py.class 7 | venv 8 | .eggs 9 | .pytest_cache 10 | *.egg-info 11 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pypi-rename cookiecutter template 2 | 3 | Cookiecutter template for creating renamed PyPI packages 4 | 5 | ## What is this for? 6 | 7 | If you want to rename a Python package that you have published on [PyPI](https://pypi.org/) you should follow [these steps](https://www.python.org/dev/peps/pep-0423/#how-to-rename-a-project): 8 | 9 | * Create a renamed version of the package 10 | * Publish it to PyPI under the new name 11 | * Now create a final release under the old name which does the following: 12 | - Tells users about the name change 13 | - Depends on the new name, so anyone who runs `pip install oldname` will get the new name as a dependency 14 | 15 | This cookiecutter template helps create that final release under the old name. 16 | 17 | ## Installation 18 | 19 | You'll need to have [cookiecutter](https://cookiecutter.readthedocs.io/) installed. I recommend [pipx](https://pipxproject.github.io/pipx/) for this: 20 | 21 | pipx install cookiecutter 22 | 23 | Regular `pip` will work OK too. 24 | 25 | ## Usage 26 | 27 | Run `cookiecutter gh:simonw/pypi-rename` and then answer the prompts. Here's an example run: 28 | 29 | $ cookiecutter gh:simonw/pypi-rename 30 | new_package_name []: my-old-package-name 31 | old_package_name []: my-new-package-name 32 | old_package_new_version []: 0.2 33 | 34 | For `old_package_new_version` you should enter a version that is higher than the most recent version that was published for the package which you are renaming. 35 | 36 | This will create a directory called `my-old-package-name` ready to be published to PyPI. 37 | 38 | See https://github.com/simonw/pypi-rename-demo for the output of this example. 39 | 40 | ## Publishing your renamed package to PyPI 41 | 42 | First, publish a version of your package under the NEW name. 43 | 44 | Now you can use the package created by this template as the last released version under the old name. 45 | 46 | This will display a README on PyPI explaining that the module has been renamed, and will also ensure that anyone who runs `pip install my-old-package-name` will get the new package, since the new package is the only dependency for the old renamed package. 47 | 48 | Here's an example run, first creating the package using `cookiecutter` and `python -m build`: 49 | ```bash 50 | % cookiecutter gh:simonw/pypi-rename 51 | [1/3] new_package_name (): click-default-group 52 | [2/3] old_package_name (): click-default-group-wheel 53 | [3/3] old_package_new_version (): 1.2.3 54 | % cd click-default-group-wheel 55 | % python -m build 56 | * Creating virtualenv isolated environment... 57 | * Installing packages in isolated environment... (setuptools >= 40.8.0, wheel) 58 | * Getting build dependencies for sdist... 59 | ... 60 | Successfully built click-default-group-wheel-1.2.3.tar.gz and click_default_group_wheel-1.2.3-py3-none-any.whl 61 | ``` 62 | And then uploading it to PyPI with `twine` - using a [PyPI API token](https://pypi.org/help/#apitoken) (pasted in as the password): 63 | ```bash 64 | % twine upload dist/click* 65 | Uploading distributions to https://upload.pypi.org/legacy/ 66 | Enter your username: __token__ 67 | Enter your password: 68 | Uploading click_default_group_wheel-1.2.3-py3-none-any.whl 69 | 100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 4.3/4.3 kB • 00:00 • ? 70 | Uploading click-default-group-wheel-1.2.3.tar.gz 71 | 100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 4.1/4.1 kB • 00:00 • ? 72 | 73 | View at: 74 | https://pypi.org/project/click-default-group-wheel/1.2.3/ 75 | ``` 76 | -------------------------------------------------------------------------------- /cookiecutter.json: -------------------------------------------------------------------------------- 1 | { 2 | "new_package_name": "", 3 | "old_package_name": "", 4 | "old_package_new_version": "" 5 | } 6 | -------------------------------------------------------------------------------- /input-for-demo.txt: -------------------------------------------------------------------------------- 1 | datasette-insert 2 | datasette-insert-api 3 | 0.5 4 | -------------------------------------------------------------------------------- /{{cookiecutter.old_package_name}}/README.md: -------------------------------------------------------------------------------- 1 | # {{ cookiecutter.old_package_name }} is now {{ cookiecutter.new_package_name }} 2 | 3 | This package has been renamed. Use `pip install {{ cookiecutter.new_package_name }}` instead. 4 | 5 | New package: https://pypi.org/project/{{ cookiecutter.new_package_name }}/ 6 | -------------------------------------------------------------------------------- /{{cookiecutter.old_package_name}}/setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | import os 3 | 4 | VERSION = "{{ cookiecutter.old_package_new_version }}" 5 | 6 | 7 | def get_long_description(): 8 | with open( 9 | os.path.join(os.path.dirname(os.path.abspath(__file__)), "README.md"), 10 | encoding="utf8", 11 | ) as fp: 12 | return fp.read() 13 | 14 | 15 | setup( 16 | name="{{ cookiecutter.old_package_name }}", 17 | description="{{ cookiecutter.old_package_name }} is now {{ cookiecutter.new_package_name }}", 18 | long_description=get_long_description(), 19 | long_description_content_type="text/markdown", 20 | version=VERSION, 21 | install_requires=["{{ cookiecutter.new_package_name }}"], 22 | classifiers=["Development Status :: 7 - Inactive"], 23 | ) 24 | --------------------------------------------------------------------------------