Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .copier-answers.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Changes here will be overwritten by Copier
_commit: c53b04c
_commit: 3a223c6
_src_path: https://github.com/python-project-templates/base.git
add_docs: true
add_extension: python
add_wiki: false
email: s.mangham@soton.ac.uk
github: Southampton-RSG
project_description: Tool for managing staff teaching time.
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
python-version: ["3.12"]

steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5

- uses: actions-ext/python/setup@main
with:
Expand Down
9 changes: 7 additions & 2 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
name: Docs
name: Publish Docs

on:
push:
branches:
Expand All @@ -10,12 +11,16 @@ jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
- uses: actions-ext/python/setup@main
<<<<<<< before updating
- run: |
sudo apt-get update
sudo apt-get install -y libldap2-dev libssl-dev libsasl2-dev
- run: uv pip install .
=======
- run: uv pip install .[develop]
>>>>>>> after updating
- run: uv pip install yardang
- run: yardang build
- uses: peaceiris/actions-gh-pages@v4
Expand Down
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -138,11 +138,16 @@ js/coverage
js/dist
js/lib
js/node_modules
js/test-results
js/playwright-report
js/*.tgz
physics_workload/extension

# Jupyter
.ipynb_checkpoints
.autoversion
!physics_workload/extension/physics_workload.json
!physics_workload/extension/install.json
physics_workload/nbextension
physics_workload/labextension

Expand Down
26 changes: 19 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@
develop: ## install dependencies and build library
uv pip install -e .[develop]

requirements: ## install prerequisite python build requirements
python -m pip install --upgrade pip toml
python -m pip install `python -c 'import toml; c = toml.load("pyproject.toml"); print("\n".join(c["build-system"]["requires"]))'`
python -m pip install `python -c 'import toml; c = toml.load("pyproject.toml"); print(" ".join(c["project"]["optional-dependencies"]["develop"]))'`

build: ## build the python library
python -m build -n

Expand All @@ -15,20 +20,27 @@ install: ## install library
#########
# LINTS #
#########
.PHONY: lint lints fix format
.PHONY: lint-py lint-docs fix-py fix-docs lint lints fix format

lint: ## run python linter with ruff
lint-py: ## lint python with ruff
python -m ruff check physics_workload
python -m ruff format --check physics_workload

# Alias
lints: lint
lint-docs: ## lint docs with mdformat and codespell
python -m mdformat --check README.md
python -m codespell_lib README.md

fix: ## fix python formatting with ruff
fix-py: ## autoformat python code with ruff
python -m ruff check --fix physics_workload
python -m ruff format physics_workload

# alias
fix-docs: ## autoformat docs with mdformat and codespell
python -m mdformat README.md
python -m codespell_lib --write README.md

lint: lint-py lint-docs ## run all linters
lints: lint
fix: fix-py fix-docs ## run all autoformatters
format: fix

################
Expand Down Expand Up @@ -88,7 +100,7 @@ dist-check: ## run python dist checker with twine

dist: clean dist-build dist-check ## build all dists

publish: dist # publish python assets
publish: dist ## publish python assets

#########
# CLEAN #
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Tool for managing staff teaching time.
[![PyPI](https://img.shields.io/pypi/v/physics-workload.svg)](https://pypi.python.org/pypi/physics-workload)


<<<<<<< before updating
## Installation

Clone the repo to the server:
Expand Down Expand Up @@ -58,5 +59,7 @@ sudo docker compose up

# Extra

=======
>>>>>>> after updating
> [!NOTE]
> This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).
Loading