From a8545211e88a250759792e731434cbccc32c31e0 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Thu, 14 Sep 2023 12:07:25 +0200 Subject: [PATCH 1/5] prep next version --- CHANGELOG.md | 9 +++++++++ pyproject.toml | 2 +- setup.py | 12 ------------ 3 files changed, 10 insertions(+), 13 deletions(-) delete mode 100644 setup.py diff --git a/CHANGELOG.md b/CHANGELOG.md index f07832c..53711e2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,15 @@ list yields a list of all related PRs for each release. # [unreleased] +# [v5.6.0] 2023-09-14 + +- `tmtccmd` v6.0.0 +- `spacepackets` v18.0.0 + +## Added + +- CFDP file downlink support. + # [v5.5.1] 2023-09-12 ## Fixed diff --git a/pyproject.toml b/pyproject.toml index bc4cbba..d29070f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta" name = "eive-tmtc" description = "TMTC Commander EIVE" readme = "README.md" -version = "5.5.1" +version = "5.6.0" requires-python = ">=3.10" license = {text = "Apache-2.0"} authors = [ diff --git a/setup.py b/setup.py deleted file mode 100644 index 77392bf..0000000 --- a/setup.py +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/env python3 -""" -We do the package handling in the static setup.cfg but include an empty setup.py -to allow editable installs https://packaging.python.org/tutorials/packaging-projects/ -and provide extensibility -""" -try: - from setuptools import setup -except ImportError: - from distutils.core import setup - -setup() From 980242404abe0cfbb74ff255c3d17b9397ddd393 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Thu, 14 Sep 2023 12:09:50 +0200 Subject: [PATCH 2/5] switch to ruff --- .flake8 | 18 ------------------ README.md | 8 ++++---- lint.py | 42 ------------------------------------------ pyproject.toml | 5 +++++ release-checklist.md | 2 +- 5 files changed, 10 insertions(+), 65 deletions(-) delete mode 100644 .flake8 delete mode 100755 lint.py diff --git a/.flake8 b/.flake8 deleted file mode 100644 index 6391e2d..0000000 --- a/.flake8 +++ /dev/null @@ -1,18 +0,0 @@ -[flake8] -max-line-length = 100 -ignore = D203, W503 -per-file-ignores = - */__init__.py: F401 -exclude = - .git, - __pycache__, - docs/conf.py, - deps - old, - build, - dist, - venv -max-complexity = 10 -extend-ignore = - # See https://github.com/PyCQA/pycodestyle/issues/373 - E203, diff --git a/README.md b/README.md index 054aca1..bf4a786 100644 --- a/README.md +++ b/README.md @@ -84,19 +84,19 @@ pip install -r requirements.txt Can be used to quickly check validity of script. Install `flake8` first ```sh -python3 -m pip install flake8 +python3 -m pip install ruff ``` or on Windows ```sh -py -m pip install flake8 +py -m pip install ruff ``` -and then run the `lint.py` script +and then run it ```sh -./lint.py +ruff . ``` # Run Auto-Formatter diff --git a/lint.py b/lint.py deleted file mode 100755 index 420bc81..0000000 --- a/lint.py +++ /dev/null @@ -1,42 +0,0 @@ -#!/usr/bin/env python3 -import os -import sys - - -def main(): - exclude_dirs_flag = "" - if not os.path.exists("setup.cfg"): - exclude_dirs_flag = ( - "--exclude .git,__pycache__,docs/conf.py,old,build,dist,venv" - ) - additional_flags_both_steps = "--count --statistics" - additional_flags_first_step = "--select=E9,F63,F7,F82 --show-source" - python_exe = "" - if os.name == "nt": - python_exe = "py -m" - flake8_first_step_cmd = ( - f"{python_exe} flake8 . {additional_flags_both_steps} " - f"{additional_flags_first_step} {exclude_dirs_flag}" - ) - status = os.system(flake8_first_step_cmd) - if os.name == "nt": - if status != 0: - print(f"Flake8 linter errors with status {status}") - else: - if os.WEXITSTATUS(status) != 0: - print(f"Flake8 linter errors with status {status}") - sys.exit(0) - additional_flags_second_step = ( - '--exit-zero --max-complexity=10 --per-file-ignores="__init__.py:F401"' - ) - if not os.path.exists("setup.cfg"): - additional_flags_second_step += " --max-line-length=100" - flake8_second_step_cmd = ( - f"{python_exe} flake8 . {additional_flags_both_steps} " - f" {additional_flags_second_step} {exclude_dirs_flag}" - ) - os.system(flake8_second_step_cmd) - - -if __name__ == "__main__": - main() diff --git a/pyproject.toml b/pyproject.toml index d29070f..a845551 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,3 +43,8 @@ include-package-data = true # Auto-Discovery is problematic for some reason, so use custom-discovery [tool.setuptools.packages] find = {} + +[tool.ruff] +ignore = ["E501"] +[tool.ruff.extend-per-file-ignores] +"__init__.py" = ["F401"] diff --git a/release-checklist.md b/release-checklist.md index 7d8a9f6..b916dcf 100644 --- a/release-checklist.md +++ b/release-checklist.md @@ -7,7 +7,7 @@ Checklist for new releases 2. Update `CHANGELOG.md`: Convert `unreleased` section into version section with date and new `unreleased`section. 3. Run auto-formatter with `black .` -4. Run linter with `flake8 .` +4. Run linter with `ruff .` # Post-Release From a30bccc995af8a98eacdef50d50cc30f7b0238f9 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Thu, 14 Sep 2023 12:12:58 +0200 Subject: [PATCH 3/5] move logo --- README.md | 2 +- logo.png => misc/logo.png | Bin 2 files changed, 1 insertion(+), 1 deletion(-) rename logo.png => misc/logo.png (100%) diff --git a/README.md b/README.md index bf4a786..2f358f5 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This application can be used to test the EIVE On-Board Software. Furthermore, it also be used to retrieve all sorts of telemetry data like housekeeping data. It is recommended to use this application with a virtual environment. -The [virtual environemnt](#venv) chapter describes how to set one up. The [requirements](#reqs) +The [virtual environment](#venv) chapter describes how to set one up. The [requirements](#reqs) describes how to install all required packages. The configuration file can currently be found at `tmtc_conf.json`. It caches settings diff --git a/logo.png b/misc/logo.png similarity index 100% rename from logo.png rename to misc/logo.png From b464182df771f4b01871cbedfa89f296ff2655cc Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Thu, 14 Sep 2023 12:18:21 +0200 Subject: [PATCH 4/5] README --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2f358f5..5a6176b 100644 --- a/README.md +++ b/README.md @@ -61,22 +61,30 @@ Run GUI mode # Install requirements There are two ways to install the requirements. One is to install the primary dependency -`tmtccmd` interactively. This is the recommended way +`tmtccmd` interactively. + +## Installing via PyPI Assuming you are running in a virtual environment: -1. Install `tmtccmd` for virtual environment. `-e` for interactive installation. +```sh +pip install -e . +``` - ```sh - cd deps/tmtccmd - pip install -e .[gui] - ``` +## Install interactively -Alternatively you can also install the packages from PyPI completely, but the risk of -incompatibilities will be high there +Clone the dependency first inside the `deps` folder ```sh -pip install -r requirements.txt +cd deps +./install_tmtccmd.sh +``` + +Then you can install `tmtccmd` interactively + +```sh +cd tmtccmd +pip install -e . ``` # Run Linter From 06a058fc4df33dd4f56e73dbbaf760af56b20390 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Thu, 14 Sep 2023 12:20:35 +0200 Subject: [PATCH 5/5] README --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5a6176b..c063bac 100644 --- a/README.md +++ b/README.md @@ -65,12 +65,19 @@ There are two ways to install the requirements. One is to install the primary de ## Installing via PyPI -Assuming you are running in a virtual environment: +It is recommended to install `eive-tmtc` itself interactively, which also installs +all required dependencies. ```sh pip install -e . ``` +If you only want to install all dependencies: + +```sh +pip install -r requirements.txt +``` + ## Install interactively Clone the dependency first inside the `deps` folder