From ca7658f0245fcc2f1f8741cbd56bb0625e79faf8 Mon Sep 17 00:00:00 2001 From: Johann Christensen Date: Thu, 19 Sep 2024 14:59:57 +0200 Subject: [PATCH] Release 1.0.0 --- .github/workflows/publish.yml | 39 +++++++++++++++++++++++++++++++++ README.md | 41 ++++++++++++++++++++--------------- VERSION | 2 +- pyproject.toml | 2 +- 4 files changed, 65 insertions(+), 19 deletions(-) create mode 100644 .github/workflows/publish.yml diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..01d67e0 --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,39 @@ +# This workflow will upload a Python Package using Twine when a release is created +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries + +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +name: Upload Python Package + +on: + release: + types: [published] + +permissions: + contents: read + +jobs: + deploy: + runs-on: ubuntu-latest + environment: + name: pypi + url: https://pypi.org/p/pycasx + permissions: + id-token: write + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.8' + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install build + - name: Build package + run: python -m build + - name: Publish package + uses: pypa/gh-action-pypi-publish@release/v1 diff --git a/README.md b/README.md index e7c216c..200500e 100644 --- a/README.md +++ b/README.md @@ -6,28 +6,35 @@ SPDX-License-Identifier: CC-BY-4.0 # `pyCASX` – A Python implementation of ACAS XA and ACAS XU for Flightgear +[![The latest version of pycasx can be found on PyPI.](https://img.shields.io/pypi/v/pycasx.svg)](https://pypi.python.org/pypi/pycasx) +[![Information on what versions of Python pycasx supports can be found on PyPI.](https://img.shields.io/pypi/pyversions/pycasx.svg)](https://pypi.python.org/pypi/pycasx) +[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/DLR-KI/pycasx/main.svg)](https://results.pre-commit.ci/latest/github/DLR-KI/pycasx/main) +[![Docs status](https://readthedocs.org/projects/pycasx/badge/)](https://pycasx.readthedocs.io/) +[![REUSE status](https://api.reuse.software/badge/github.com/DLR-KI/pycasx)](https://api.reuse.software/info/github.com/DLR-KI/pycasx) + Implementation of ACAS XA and ACAS XU with neural networks for FlightGear. -- [Description](#description) -- [Installation](#installation) - - [Requirements](#requirements) - - [Users](#users) - - [Installation via `pipx`](#installation-via-pipx) - - [Installation via `pip`](#installation-via-pip) - - [Development](#development) - - [`pre-commit`](#pre-commit) - - [VS Code](#vs-code) -- [Usage](#usage) - - [Launching ACAS X](#launching-acas-x) - - [Other options](#other-options) - - [`onnx` or `make_onnx`](#onnx-or-make_onnx) - - [`launch`](#launch) - - [`acasx`](#acasx) - - [Overwriting parameters](#overwriting-parameters) -- [Citation](#citation) +- [`pyCASX` – A Python implementation of ACAS XA and ACAS XU for Flightgear](#pycasx--a-python-implementation-of-acas-xa-and-acas-xu-for-flightgear) + - [Description](#description) + - [Installation](#installation) + - [Requirements](#requirements) + - [Users](#users) + - [Installation via `pipx`](#installation-via-pipx) + - [Installation via `pip`](#installation-via-pip) + - [Development](#development) + - [`pre-commit`](#pre-commit) + - [VS Code](#vs-code) + - [Usage](#usage) + - [Launching ACAS X](#launching-acas-x) + - [Other options](#other-options) + - [`onnx` or `make_onnx`](#onnx-or-make_onnx) + - [`launch`](#launch) + - [`acasx`](#acasx) + - [Overwriting parameters](#overwriting-parameters) + - [Citation](#citation) diff --git a/VERSION b/VERSION index 1750564..3eefcb9 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.0.6 +1.0.0 diff --git a/pyproject.toml b/pyproject.toml index 09bcf61..52c72c3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -103,7 +103,7 @@ file = "README.md" pycasx = "pycasx.cli.cli:main" [project.urls] -Documentation = "https://DLR-KI.github.io/pycasx/" +Documentation = "https://pycasx.readthedocs.io/" Homepage = "https://github.com/DLR-KI/pycasx.git" Source = "https://github.com/DLR-KI/pycasx.git" Tracker = "https://github.com/DLR-KI/pycasx/-/issues"