-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: switch to pyproject.toml and update other CI files
Also use uv for publishing
- Loading branch information
Showing
9 changed files
with
189 additions
and
142 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
#!/usr/bin/env python3 | ||
''' | ||
Deploys Python package onto [[https://pypi.org][PyPi]] or [[https://test.pypi.org][test PyPi]]. | ||
- running manually | ||
You'll need =UV_PUBLISH_TOKEN= env variable | ||
- running on Github Actions | ||
Instead of env variable, relies on configuring github as Trusted publisher (https://docs.pypi.org/trusted-publishers/) -- both for test and regular pypi | ||
It's running as =pypi= job in [[file:.github/workflows/main.yml][Github Actions config]]. | ||
Packages are deployed on: | ||
- every master commit, onto test pypi | ||
- every new tag, onto production pypi | ||
''' | ||
|
||
UV_PUBLISH_TOKEN = 'UV_PUBLISH_TOKEN' | ||
|
||
import argparse | ||
import os | ||
import shutil | ||
from pathlib import Path | ||
from subprocess import check_call | ||
|
||
is_ci = os.environ.get('CI') is not None | ||
|
||
def main() -> None: | ||
p = argparse.ArgumentParser() | ||
p.add_argument('--use-test-pypi', action='store_true') | ||
args = p.parse_args() | ||
|
||
publish_url = ['--publish-url', 'https://test.pypi.org/legacy/'] if args.use_test_pypi else [] | ||
|
||
root = Path(__file__).absolute().parent.parent | ||
os.chdir(root) # just in case | ||
|
||
if is_ci: | ||
# see https://github.com/actions/checkout/issues/217 | ||
check_call('git fetch --prune --unshallow'.split()) | ||
|
||
# TODO ok, for now uv won't remove dist dir if it already exists | ||
# https://github.com/astral-sh/uv/issues/10293 | ||
dist = root / 'dist' | ||
if dist.exists(): | ||
shutil.rmtree(dist) | ||
|
||
# todo what is --force-pep517? | ||
check_call(['uv', 'build']) | ||
|
||
if not is_ci: | ||
# CI relies on trusted publishers so doesn't need env variable | ||
assert UV_PUBLISH_TOKEN in os.environ, f'no {UV_PUBLISH_TOKEN} passed' | ||
|
||
check_call(['uv', 'publish', *publish_url]) | ||
|
||
|
||
if __name__ == '__main__': | ||
main() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -78,12 +78,12 @@ This is convenient if you're planning to add new modules or change the existing | |
|
||
It's *extremely* convenient for developing and debugging. | ||
|
||
** option 3: use without installing | ||
This is less convenient, but gives you more control. | ||
** option 3: use without installing (deprecated) | ||
NOTE: this is deprecated -- it's almost always better to simply use an editable install. | ||
|
||
1. Clone the repository: =git clone [email protected]:karlicoss/HPI.git /path/to/hpi= | ||
2. Go into the project directory: =cd /path/to/hpi= | ||
3. Install the dependencies: ~python3 setup.py --dependencies-only~ | ||
3. Install the necessary dependencies (see =pyproject.toml=) | ||
4. Use =with_my= script to get access to ~my.~ modules. | ||
|
||
For example: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
# see https://github.com/karlicoss/pymplate for up-to-date reference | ||
[project] | ||
dynamic = ["version"] # version is managed by setuptools_scm | ||
# NOTE: 'my' is taken for PyPi already, and makes discovering the project impossible | ||
# , so we're using HPI | ||
name = "HPI" | ||
dependencies = [ | ||
"pytz" , # even though it's not needed by the core, it's so common anyway... | ||
"typing-extensions" , # one of the most common pypi packages, ok to depend for core | ||
"appdirs" , # very common, and makes it portable | ||
"more-itertools" , # it's just too useful and very common anyway | ||
"decorator" , # less pain in writing correct decorators. very mature and stable, so worth keeping in core | ||
"click>=8.1" , # for the CLI, printing colors, decorator-based - may allow extensions to CLI | ||
"kompress>=0.2.20240918" , # for transparent access to compressed files via pathlib.Path | ||
|
||
] | ||
requires-python = ">=3.9" | ||
|
||
## these need to be set if you're planning to upload to pypi | ||
description = "A Python interface to my life" | ||
license = {file = "LICENSE"} | ||
authors = [ | ||
{name = "Dima Gerasimov (@karlicoss)", email = "[email protected]"}, | ||
] | ||
maintainers = [ | ||
{name = "Dima Gerasimov (@karlicoss)", email = "[email protected]"}, | ||
] | ||
# keywords = [] | ||
# # see: http://pypi.python.org/pypi?%3Aaction=list_classifiers | ||
# classifiers = [ | ||
# ] | ||
|
||
|
||
[project.urls] | ||
Homepage = "https://github.com/karlicoss/HPI" | ||
## | ||
|
||
|
||
[project.optional-dependencies] | ||
optional = [ | ||
# todo document these? | ||
"orjson", # for my.core.serialize | ||
"pyfzf_iter", # for my.core.denylist | ||
"cachew>=0.15.20231019", | ||
"mypy", # used for config checks | ||
"colorlog", # for colored logs | ||
"enlighten", # for CLI progress bars | ||
] | ||
|
||
[dependency-groups] | ||
testing = [ | ||
"pytest", | ||
"ruff", | ||
"mypy", | ||
"lxml", # for mypy coverage | ||
|
||
# used in some tests.. although shouldn't rely on it | ||
"pandas", | ||
|
||
"orjson", # for my.core.serialize and denylist | ||
"simplejson", # for my.core.serialize | ||
|
||
## | ||
# ideally we'd use --instal-types in mypy | ||
# , but looks like it doesn't respect uv venv if it's running in it :( | ||
"types-pytz" , # for my.core | ||
"types-decorator" , # for my.core.compat | ||
"pandas-stubs" , # for my.core.pandas | ||
"types-dateparser", # for my.core.query_range | ||
"types-simplejson", # for my.core.serialize | ||
## | ||
] | ||
|
||
[project.scripts] | ||
hpi = "my.core.__main__:main" | ||
|
||
|
||
[build-system] | ||
requires = ["setuptools", "setuptools-scm"] | ||
build-backend = "setuptools.build_meta" | ||
|
||
[tool.setuptools_scm] | ||
version_scheme = "python-simplified-semver" | ||
local_scheme = "dirty-tag" | ||
|
||
# workaround for error during uv publishing | ||
# see https://github.com/astral-sh/uv/issues/9513#issuecomment-2519527822 | ||
[tool.setuptools] | ||
license-files = [] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.