Skip to content

Commit

Permalink
Enable building for pypi
Browse files Browse the repository at this point in the history
- Add pyproject.toml and use hatchling build
- Add build+publish github action
- Modernize gitignore
  • Loading branch information
tcjennings committed Jan 21, 2025
1 parent b189883 commit 1db2277
Show file tree
Hide file tree
Showing 3 changed files with 372 additions and 11 deletions.
92 changes: 92 additions & 0 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
name: build_and_test

on:
push:
branches:
- main
- "u/**"
tags:
- "*"
pull_request:

jobs:
build_and_test:
runs-on: ubuntu-24.04
strategy:
matrix:
python-version: ["3.11", "3.12"]

steps:
- uses: actions/checkout@v4
with:
# Need to clone everything for the git tags.
fetch-depth: 0

- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.x"
enable-cache: true
python-version: ${{ matrix.python-version }}

- name: Write version information
run: >-
uv run --with "lsst_versions" --isolated --no-sync
python -c "from lsst_versions._cmd import main; main()" --write-version .
- name: Install dependencies
run: |
uv sync --no-install-project
- name: Run tests
run: >-
uv run pytest -r a -v -n 3
--cov=lsst.ctrl.exec --cov-report=xml --cov-report=term --cov-branch
--junitxml=junit.xml -o junit_family=legacy
# - name: Upload coverage to codecov
# uses: codecov/codecov-action@v4
# with:
# files: ./coverage.xml
# token: ${{ secrets.CODECOV_TOKEN }}

# - name: Upload test results to Codecov
# if: ${{ !cancelled() }}
# uses: codecov/test-results-action@v1
# with:
# token: ${{ secrets.CODECOV_TOKEN }}

pypi:
runs-on: ubuntu-24.04
needs: [build_and_test]
# The "not starts with 's'" is meant to catch server release tags in the
# form 'server/x.y.z'
# if: startsWith(github.ref, 'refs/tags') && ! startsWith(github.ref, 'refs/tags/s')

steps:
- uses: actions/checkout@v4
with:
# Need to clone everything to embed the version.
fetch-depth: 0

- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.x"
enable-cache: true
python-version: "3.11"

- name: Write version information
run: >-
uv run --with "lsst_versions" --isolated --no-sync
python -c "from lsst_versions._cmd import main; main()" --write-version .
- name: Build and create distribution
run: |
uv build
# - name: Upload
# uses: pypa/gh-action-pypi-publish@release/v1
# with:
# user: __token__
# password: ${{ secrets.PYPI_UPLOADS }}
237 changes: 226 additions & 11 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,14 +1,229 @@
_build.*
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon

# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk
*~

# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*

# .nfs files are created when an open file is removed but is still being accessed
.nfs*

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# UV
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
uv.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
.pdm.toml
.pdm-python
.pdm-build/

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.env.*
.envrc
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

# PyPI configuration file
.pypirc

# Local Ignores

# Do not commit the local version file
**/version.py

# VS Code
.vscode/

# Ruff
# Ruff usually installs a .gitignore file in its directory.
.ruff_cache/

# Scons
.sconsign.dblite
config.log
.sconf_temp
*.pyc
*.cfgc
tests/.tests
version.py
bin/allocateNodes.py
bin/dagIdInfo.py
bin/qdelete.py
bin/qstatus.py
python/*.dist-info/
54 changes: 54 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
[project]
name = "lsst-ctrl-execute"
requires-python = ">=3.11.0,<3.13.0"
description = "Utilities for executing and managing workloads."
license = {text = "BSD 3-Clause License"}
authors = [
{name="Rubin Observatory Data Management", email="[email protected]"},
]
classifiers = [
"Intended Audience :: Science/Research",
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Topic :: Scientific/Engineering :: Astronomy",
]
keywords = ["lsst"]
dependencies = [
"lsst-ctrl-bps-htcondor>=28.2024.5000; sys_platform == 'linux'",
"lsst-pex-config",
"lsst-utils",
]
dynamic = ["version"]

[dependency-groups]
dev = [
"lsst-versions",
"pytest",
"pytest-xdist",
"pytest-cov"
]

[project.urls]
"Homepage" = "https://github.com/lsst/ctrl_execute"

[project.scripts]
allocate_nodes = "bin.allocateNodes:main"

[build-system]
requires = ["hatchling", "lsst-versions@git+file:///Users/tobyj/git/lsst_versions@tickets/DM-48515"]
build-backend = "hatchling.build"

[tool.hatch.version]
source = "lsst"

[tool.hatch.build.targets.wheel]
packages = ["python/lsst"]

[tool.hatch.build.targets.wheel.force-include]
"./bin.src" = "bin"

[tool.lsst_versions]
write_to = "python/lsst/ctrl/execute/version.py"

0 comments on commit 1db2277

Please sign in to comment.