Merge pull request #15 from cdce8p/dev

Release v0.3.1

Author: cdce8p

.github/workflows/release.yaml

@@ -0,0 +1,36 @@
+name: Release
+
+on:
+  release:
+    types:
+      - created
+
+env:
+  DEFAULT_PYTHON: 3.9
+
+jobs:
+  release-pypi:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code from Github
+        uses: actions/[email protected]
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
+        id: python
+        uses: actions/[email protected]
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+      - name: Install requirements
+        run: |
+          python -m pip install -U pip setuptools twine wheel
+      - name: Build distributions
+        run: |
+          python setup.py sdist bdist_wheel
+      - name: Upload to PyPI
+        if: github.event_name == 'release' && startsWith(github.ref, 'refs/tags')
+        env:
+          TWINE_REPOSITORY: pypi
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          twine upload --verbose dist/*

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.10.1
+    rev: v2.11.0
     hooks:
       - id: pyupgrade
         args: [--py38-plus]
@@ -12,7 +12,7 @@ repos:
         files: ^(python_typing_update|script|tests)/.+\.py$
         exclude: *fixtures
   - repo: https://github.com/PyCQA/isort
-    rev: 5.7.0
+    rev: 5.8.0
     hooks:
       - id: isort
         exclude:  *fixtures

.vscode/tasks.json

@@ -0,0 +1,16 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Build package",
+            "type": "shell",
+            "command": "rm -rf build dist *.egg-info; source venv/bin/activate; python setup.py sdist bdist_wheel",
+            "group": {
+                "kind": "build",
+                "isDefault": true,
+            },
+        },
+    ]
+}

README.md

@@ -12,8 +12,8 @@ It uses token analysis and
 to try and update the typing syntax the best it can.
 
 **Important**  
-Since every project uses a different formatting style,
-always check `git diff` before committing any changes!  
+Every project uses a different formatting style,
+so always check `git diff` before comitting any changes!
 Since this tool uses [pyupgrade][pyu], it's best used for
 projects that use it already.
 
@@ -119,7 +119,7 @@ Set the minimum Python syntax version to **3.10**. (Default: **3.8**)
 
 ## License
 This Project is licensed under the MIT license.
-See [LICENSE](LICENSE) for the full license text.
+See [LICENSE][LICENSE_FILE] for the full license text.
 
 
 [pri]: https://github.com/asottile/reorder_python_imports
@@ -129,3 +129,5 @@ See [LICENSE](LICENSE) for the full license text.
 [black]: https://github.com/psf/black
 [PEP585]: https://www.python.org/dev/peps/pep-0585/
 [PEP604]: https://www.python.org/dev/peps/pep-0604/
+
+[LICENSE_FILE]: https://github.com/cdce8p/python-typing-update/blob/main/LICENSE

python_typing_update/__main__.py

@@ -67,7 +67,7 @@ async def async_main(argv: list[str] | None = None) -> int:
     parser.add_argument(
         '--disable-committed-check',
         action='store_true',
-        help="Don't abort with uncommited changes. Don't use it in production!",
+        help="Don't abort with uncommitted changes. Don't use it in production!",
     )
 
     group_mode = mode_options.add_mutually_exclusive_group()

python_typing_update/const.py

@@ -6,12 +6,12 @@
 from enum import Flag, auto
 from typing import NamedTuple
 
-version = (0, 3, 0)
-dev_version = None
+version = (0, 3, 1)
+dev_version = None  # Set to `None` for release
 
 version_str = '.'.join(map(str, version))
 if dev_version is not None:
-    version_str += f'-dev{dev_version}'
+    version_str += f'.dev{dev_version}'
 
 
 class FileAttributes(NamedTuple):

python_typing_update/main.py

@@ -148,7 +148,7 @@ async def async_run(args: argparse.Namespace) -> int:
         1: Check did not pass, files would be updated
         2: Couldn't update all files
         10: At least one file doesn't exist
-        11: Uncommited changes in '.py' files
+        11: Uncommitted changes in '.py' files
         12: Debug mode
     """
     if file_errors := check_files_exist(args.filenames):

requirements.txt

@@ -1,5 +1,5 @@
 aiofiles==0.6.0
 autoflake==1.4
-isort==5.7.0
-pyupgrade==2.10.1
+isort==5.8.0
+pyupgrade==2.11.0
 reorder-python-imports==2.4.0

requirements_test_pre_commit.txt

@@ -1,3 +1,3 @@
 flake8==3.9.0
-isort==5.7.0
-pyupgrade==2.10.1
+isort==5.8.0
+pyupgrade==2.11.0

setup.cfg

@@ -2,15 +2,27 @@
 name = python-typing-update
 author = Marc Mueller
 description = Update Python typing syntax
+long_description = file:README.md
+long_description_content_type = text/markdown
 keywords = typing,pep585,pep604
 license = MIT
+license_files =
+    LICENSE
+    AUTHORS
+url = https://github.com/cdce8p/python-typing-update
+classifier =
+    Development Status :: 4 - Beta
+    Intended Audience :: Developers
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Topic :: Software Development
 
 [flake8]
 ignore = E203,E231,E701,W503,W504
 # E203,E231,E701 -> walrus
 # W503/504 -> line-break-before/after-binary-operator
-max-line-length = 119
-extend-exclude =
+max_line_length = 119
+extend_exclude =
     .github,
     .vscode,
     tests/fixtures,