CI Overhaul #6
CI Overhaul #6
Conversation
| [flake8] | ||
| # B = bugbear | ||
| # B9 = bugbear opinions | ||
| # BLK = black style warnings |
There was a problem hiding this comment.
I'm having flake8 check black and isort formatting because I prefer to have flake8 statically check formatting rather than running Git modifying code in CI, although the difference is pretty arbitrary.
There was a problem hiding this comment.
I haven't gotten a ton of use out of this personally but it's an easy add and I like it in theory. Described here.
| - run: pip install nox poetry | ||
| - run: nox --python 3.8 | ||
| - run: poetry build | ||
| - run: poetry publish --username=__token__ --password=${{ secrets.PYPI_TOKEN }} |
There was a problem hiding this comment.
You'll need to set up a PyPI API token in GitHub but this will allow you to release to PyPI with a Github release.
| strategy: | ||
| matrix: | ||
| python-version: ['3.9', '3.8', '3.7'] | ||
| os: [ubuntu-latest] |
There was a problem hiding this comment.
You may want to eventually add macos-latest here because you mention Mac support in your package classifiers. I'm omitting it for efficiency right now.
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| matrix: | ||
| python-version: ['3.9', '3.8', '3.7'] |
There was a problem hiding this comment.
Not testing past 3.9 yet just for efficiency.
| import nox | ||
| from nox.sessions import Session | ||
|
|
||
| nox.options.sessions = "lint", "mypy", "tests" |
There was a problem hiding this comment.
As mentioned in the .flake8 comment, I try to only have nox run non-Git-modifying code, so black and isort are left out of the default sessions. You can, however, still explicitly run them (e.x. locally).
| [tool.poetry.group.black.dependencies] | ||
| black = ">=22.3" | ||
|
|
||
| [tool.poetry.group.isort.dependencies] | ||
| isort = ">=5.10" |
There was a problem hiding this comment.
Taking advantage of poetry's ability to have an arbitrary number of dependency sections. The built package will only ever require what is specified in root dependencies section + optional extras.
| try: | ||
| from importlib.metadata import PackageNotFoundError # type: ignore | ||
| from importlib.metadata import version # type: ignore | ||
| except ImportError: # pragma: no cover | ||
| from importlib_metadata import version, PackageNotFoundError # type: ignore |
There was a problem hiding this comment.
Boilerplate __version__ code.
| try: | ||
| __version__ = version(__name__) | ||
| except PackageNotFoundError: # pragma: no cover | ||
| try: | ||
| __version__ = version(__name__.replace(".", "-")) | ||
| # Due to interaction between Poetry's name normalization and Python < 3.9 | ||
| except PackageNotFoundError: # pragma: no cover | ||
| __version__ = "unknown" |
There was a problem hiding this comment.
More boilerplate __version__ code.
There was a problem hiding this comment.
This had to change now that we're using an implicit namespace, but this test is probably superfluous as a whole, given that we're using a src organization that requires the package to be installed in order to test it.
| @@ -0,0 +1,109 @@ | |||
| [tool.poetry] | |||
| name = "bourbaki-introspection" | |||
There was a problem hiding this comment.
I'm not 100% on how I feel about this, but poetry definitely wants you to only use the - separator in the package name, including namespaces.
| @@ -0,0 +1,109 @@ | |||
| [tool.poetry] | |||
| name = "bourbaki-introspection" | |||
| version = "0.5.10" | |||
There was a problem hiding this comment.
poetry lets you easily bump your version with poetry version.
This PR should (hopefully) provide a modern CI/CD framework for
bourbaki-introspectionand serve as a model for otherbourbakilibraries. It is heavily influnced by this Hypermodern Python but has some additional changes either due to necessity or opinion.There are a lot of changes here but very few to the library internals. Basically my changes can be summarized as:
poetry.flake8andmypy, the latter of which was not happy.noxto automate our various lint/check/test steps over multiple Python versions.pre-commit.The package will test successfully on Python 3.7 and 3.8, but fails to run on 3.9. The package will fail the current
flake8andmypychecks for all Python versions checked. Feel free to modify their strictness/behavior as you see fit.