Update GitHub repo name to xkcd-pass-python.

adambirds · Aug 19, 2022 · e81a70e · e81a70e
1 parent c1810c2
commit e81a70e
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 18 deletions.
diff --git a/.github/workflows/publish-to-pypi.yml b/.github/workflows/publish-to-pypi.yml
@@ -56,13 +56,13 @@ jobs:
         --wheel
         --outdir dist/
         .
-    - name: Publish xkcd_pass to Test PyPI
+    - name: Publish xkcd-pass to Test PyPI
       uses: pypa/gh-action-pypi-publish@master
       with:
         password: ${{ secrets.TEST_PYPI_API_TOKEN }}
         repository_url: https://test.pypi.org/legacy/
         skip_existing: true
-    - name: Publish xkcd_pass to PyPI
+    - name: Publish xkcd-pass to PyPI
       if: startsWith(github.ref, 'refs/tags')
       uses: pypa/gh-action-pypi-publish@master
       with:

diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 # xkcd-pass
-![build status](https://github.com/adambirds/xkcd-password-gen/actions/workflows/build.yml/badge.svg)
+![build status](https://github.com/adambirds/xkcd-pass-python/actions/workflows/build.yml/badge.svg)
 [![PyPI version](https://badge.fury.io/py/xkcd-pass.svg)](https://badge.fury.io/py/xkcd_pass)
-[![codecov](https://codecov.io/gh/adambirds/xkcd-password-gen/branch/master/graph/badge.svg?token=Ia2ppYjdkw)](https://codecov.io/gh/adambirds/xkcd-password-gen)
+[![codecov](https://codecov.io/gh/adambirds/xkcd-pass-python/branch/master/graph/badge.svg?token=Ia2ppYjdkw)](https://codecov.io/gh/adambirds/xkcd-pass-python)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/xkcd-pass)
-[![GitHub release](https://img.shields.io/github/release/adambirds/xkcd-password-gen.svg)](https://github.com/adambirds/xkcd-password-gen/releases/latest)
+[![GitHub release](https://img.shields.io/github/release/adambirds/xkcd-pass-python.svg)](https://github.com/adambirds/xkcd-pass-python/releases/latest)
 [![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![mypy coverage](https://img.shields.io/badge/mypy-100%25-green.svg)](https://github.com/python/mypy)
 ![GitHub Sponsors](https://img.shields.io/github/sponsors/adambirds)
@@ -15,7 +15,7 @@ $ xkcd-pass
 > DenotePetroleumMournfulStoreroom47
 ```
 
-Whilst this password generator is inspired by [XKCD 936][xkcd], its defaults have been configured in a way which gives this tool the most compatibility out of the box with the majority of services we use passwords for today. The faults that we have set are:
+Whilst this password generator is inspired by [XKCD 936][xkcd], its defaults have been configured in a way which gives this tool the most compatibility out of the box with the majority of services we use passwords for today. The defaults that we have set are:
 * Phrase containing 4 words between 5 and 9 characters (The default wordfile `eff-long` only contains words between 5 and 9 characters).
 * The first letter of each word is capitalized.
 * The passphrase is ended with two random digits.
@@ -51,7 +51,7 @@ python setup.py install
 ```
 
 ## Source
-The source code can be found [here](https://github.com/adambirds/xkcd-password-gen).
+The source code can be found [here](https://github.com/adambirds/xkcd-pass-python).
 
 Contributions welcome and gratefully appreciated!
 
@@ -149,12 +149,14 @@ Note that `xkcd-pass` can be used with any word file of the correct format: a fi
     * Fix dependency issues.
     * Add more PyPi classifiers.
     * Make CI run tests on multiple Python versions.
+* **Version 1.1.3**
+    * Rename the GitHub repository to `xkcd-pass-python` from `xkcd-password-gen`.
 
 ## License
 
-This project is released under the [GNU GENERAL PUBLIC LICENSE v3](https://github.com/adambirds/xkcd-password-gen/blob/master/LICENSE). However the original code from [redacted/xkcd-password-generator](https://github.com/redacted/XKCD-password-generator) is licensed under the [BSD 3-Clause license](https://github.com/adambirds/xkcd-password-gen/blob/master/LICENSE.BSD).
+This project is released under the [GNU GENERAL PUBLIC LICENSE v3](https://github.com/adambirds/xkcd-pass-python/blob/master/LICENSE). However the original code from [redacted/xkcd-password-generator](https://github.com/redacted/XKCD-password-generator) is licensed under the [BSD 3-Clause license](https://github.com/adambirds/xkcd-pass-python/blob/master/LICENSE.BSD).
 
 ## Contributing
 
 Anybody is welcome to contribute to this project. I just ask that you check out our contributing guidelines
-[here](https://github.com/adambirds/xkcd-password-gen/blob/master/docs/contributing/contributing.md) first.
+[here](https://github.com/adambirds/xkcd-pass-python/blob/master/docs/contributing/contributing.md) first.
diff --git a/docs/contributing/contributing.md b/docs/contributing/contributing.md
@@ -34,7 +34,7 @@ source xkcd-password-gen/bin/activate
 
 The middle command will setup some commit hooks to run our linters on any changed files before
 the commit and then run the linters on your commit message to ensure it meets our
-commit message guidelines. You can read our guidelines [here](https://github.com/adambirds/xkcd-password-gen/blob/master/docs/contributing/commit-guidelines.md).
+commit message guidelines. You can read our guidelines [here](https://github.com/adambirds/xkcd-pass-python/blob/master/docs/contributing/commit-guidelines.md).
 
 ## Linters and Tests
 

diff --git a/package.json b/package.json
@@ -15,12 +15,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/adambirds/xkcd-password-gen.git"
+    "url": "git+https://github.com/adambirds/xkcd-pass-python.git"
   },
   "author": "",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/adambirds/xkcd-password-gen/issues"
+    "url": "https://github.com/adambirds/xkcd-pass-python/issues"
   },
-  "homepage": "https://github.com/adambirds/xkcd-password-gen#readme"
+  "homepage": "https://github.com/adambirds/xkcd-pass-python#readme"
 }
diff --git a/setup.py b/setup.py
@@ -6,15 +6,15 @@
 install_requires = ["argcomplete"]
 setuptools.setup(
     name="xkcd-pass",
-    version="1.1.2",
+    version="1.1.3",
     author="Adam Birds",
     author_email="[email protected]",
     description="Generate secure multiword passwords/passphrases, inspired by XKCD",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="https://github.com/adambirds/xkcd-password-gen",
+    url="https://github.com/adambirds/xkcd-pass-python",
     project_urls={
-        "Bug Tracker": "https://github.com/adambirds/xkcd-password-gen/issues",
+        "Bug Tracker": "https://github.com/adambirds/xkcd-pass-python/issues",
     },
     license="LGPLv3",
     classifiers=[

diff --git a/tools/commit-message-lint b/tools/commit-message-lint
@@ -8,7 +8,7 @@
 if [[ "
 $(git remote -v)
 " =~ '
-'([^[:space:]]*)[[:space:]]*(https://github\.com/|ssh://git@github\.com/|git@github\.com:)adambirds/xkcd-password-gen(\.git|/)?\ \(fetch\)'
+'([^[:space:]]*)[[:space:]]*(https://github\.com/|ssh://git@github\.com/|git@github\.com:)adambirds/xkcd-pass-python(\.git|/)?\ \(fetch\)'
 ' ]]; then
 	range="${BASH_REMATCH[1]}/master..HEAD"
 else

diff --git a/tools/setup-git-repo b/tools/setup-git-repo
@@ -2,7 +2,7 @@
 
 if ! [ -d ".git/hooks/" ]; then
 	echo "Error: Could not find .git/hooks directory"
-	echo "Please re-run this script from the root of your xkcd-password-gen.git checkout"
+	echo "Please re-run this script from the root of your xkcd-pass-python.git checkout"
 	exit 1
 fi