mirror of
https://github.com/nqrduck/nqrduck-measurement.git
synced 2024-09-07 21:30:34 +00:00
Automatic PyPi deployment.
This commit is contained in:
parent
0b28ae6b33
commit
e14cc7b7ac
5 changed files with 67 additions and 7 deletions
44
.github/workflows/python-publish.yml
vendored
Normal file
44
.github/workflows/python-publish.yml
vendored
Normal file
|
@ -0,0 +1,44 @@
|
|||
name: Build, Test, and Upload Python Package
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "v*.*.*"
|
||||
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
# test:
|
||||
# uses: ./.github/workflows/ubuntu-python-package.yml # use the callable tests job to run tests
|
||||
|
||||
deploy:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
# needs: [test]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v3
|
||||
with:
|
||||
python-version: "3.11"
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
sudo apt-get update
|
||||
python -m pip install --upgrade pip
|
||||
|
||||
- name: Publish to PyPI
|
||||
run: |
|
||||
python -m venv venv
|
||||
. ./venv/bin/activate
|
||||
pip install -U twine build
|
||||
python -m build .
|
||||
python -m twine upload --repository pypi --username __token__ --password ${{ secrets.PYPI }} dist/*
|
||||
env:
|
||||
PYPI: ${{ secrets.PYPI }}
|
|
@ -1,4 +1,7 @@
|
|||
# Changelog
|
||||
|
||||
### Version 0.0.2 (17-04-2024)
|
||||
- Deployment to PyPi via github actions
|
||||
|
||||
### Version 0.0.1 (15-04-2024)
|
||||
- Initial release
|
2
LICENSE
2
LICENSE
|
@ -1,6 +1,6 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2023 Julia Pfitzer
|
||||
Copyright (c) 2023 jupfi
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
|
|
@ -22,6 +22,11 @@ You can install this module and the dependencies by running the following comman
|
|||
pip install .
|
||||
```
|
||||
|
||||
Alternatively, you can install the module and the dependencies by running the following command in the terminal while the virtual environment is activated:
|
||||
```bash
|
||||
pip install nqrduck-measurement
|
||||
```
|
||||
|
||||
## Usage
|
||||
The module is used with the [Spectrometer](https://github.com/nqrduck/nqrduck-spectrometer) module. However you need to use an actual submodule of the spectrometer module like:
|
||||
|
||||
|
@ -30,7 +35,7 @@ The module is used with the [Spectrometer](https://github.com/nqrduck/nqrduck-sp
|
|||
|
||||
The pulse sequence and spectrometer settings can be adjusted using the 'Spectrometer' tab.
|
||||
|
||||
<img src="docs/img/measurement_ui_labeled_v2.png" alt="drawing" width="800">
|
||||
<img src="https://github.com/nqrduck/nqrduck-measurement/raw/0b28ae6b33230c6ca9eda85bd18de7cbcade27d1/docs/img/measurement_ui_labeled_v2.png" alt="drawing" width="800">
|
||||
|
||||
- a.) The experiments settings for frequency and number of averages.
|
||||
- b.) The signal processing settings for the measurement.
|
||||
|
|
|
@ -7,15 +7,15 @@ allow-direct-references = true
|
|||
|
||||
[project]
|
||||
name = "nqrduck-measurement"
|
||||
version = "0.0.1"
|
||||
version = "0.0.2"
|
||||
authors = [
|
||||
{ name="Julia Pfitzer", email="git@jupfi.me" },
|
||||
{ name="jupfi", email="support@nqrduck.cool" },
|
||||
]
|
||||
|
||||
description = "A module for the NQRduck program (a simple python script™) to perform single frequency measurements."
|
||||
readme = "README.md"
|
||||
license = { file="LICENSE" }
|
||||
requires-python = ">=3.8"
|
||||
requires-python = ">=3.10"
|
||||
|
||||
classifiers = [
|
||||
"Programming Language :: Python :: 3",
|
||||
|
@ -27,7 +27,7 @@ dependencies = [
|
|||
"matplotlib",
|
||||
"pyqt6",
|
||||
"sympy",
|
||||
"NQRduck",
|
||||
"nqrduck",
|
||||
"nqrduck-pulseprogrammer",
|
||||
"nqrduck-spectrometer",
|
||||
]
|
||||
|
@ -59,4 +59,12 @@ extend-select = [
|
|||
"__init__.py" = ["F401"]
|
||||
|
||||
[tool.ruff.lint.pydocstyle]
|
||||
convention = "google"
|
||||
convention = "google"
|
||||
|
||||
[project.urls]
|
||||
"Homepage" = "https://nqrduck.cool"
|
||||
"Bug Tracker" = "https://github.com/nqrduck/nqrduck-measurement/issues"
|
||||
"Source Code" = "https://github.com/nqrduck/nqrduck-measurement"
|
||||
|
||||
[tool.hatch.build.targets.wheel]
|
||||
packages = ["src/nqrduck_measurement"]
|
Loading…
Reference in a new issue