From e435b19c5b9a053180d4d442fb6e323224e80ef2 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 16 Dec 2023 10:29:04 +0100 Subject: [PATCH 1/2] ci(deps): bump actions/setup-python from 4 to 5 (#69) Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 5. - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/v4...v5) --- updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/prchecks.yml | 2 +- .github/workflows/release.yml | 2 +- .github/workflows/tests.yml | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/prchecks.yml b/.github/workflows/prchecks.yml index c92eda1..27bbbe3 100644 --- a/.github/workflows/prchecks.yml +++ b/.github/workflows/prchecks.yml @@ -24,7 +24,7 @@ jobs: steps: - uses: actions/checkout@v4 - - uses: actions/setup-python@v4 + - uses: actions/setup-python@v5 with: python-version: 3.x - uses: psf/black@20.8b1 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 017d356..ee01a8c 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -12,7 +12,7 @@ jobs: steps: - uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: '3.x' - name: Setup environment diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index df6e8f9..fac0a0a 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -28,7 +28,7 @@ jobs: steps: - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python_version }} - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python_version }} architecture: x64 @@ -63,7 +63,7 @@ jobs: steps: - uses: actions/checkout@v4 - name: Prepare Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: "3.x" From 7aff41be45f3e0626d79c8978970b5a0b2f1b0dd Mon Sep 17 00:00:00 2001 From: Deuchnord Date: Sat, 16 Dec 2023 10:38:56 +0100 Subject: [PATCH 2/2] chore: update Readme --- README.md | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 926e733..92d29f0 100644 --- a/README.md +++ b/README.md @@ -2,29 +2,21 @@ [![Coverage Status](https://coveralls.io/repos/github/Kosmorro/lib/badge.svg?branch=main)](https://coveralls.io/github/Kosmorro/lib?branch=main) [![Version on PyPI](https://img.shields.io/pypi/v/kosmorrolib)](https://pypi.org/project/kosmorrolib) [![IRC: #kosmorro on Libera.Chat](https://img.shields.io/badge/Libera.Chat-%23kosmorro-blueviolet)](https://web.libera.chat/?nick=Astronaut?#kosmorro) -[![Stand with Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) +Kosmorrolib is the Python library internally used in Kosmorro. It provides easy-to-use functions for your calculation needs. -## Installation - -### Requirements - -Kosmorrolib requires the following software to work: +The library is built on [Skyfield](https://rhodesmill.org/skyfield/), an excellent library designed to compute positions for any objects in the Solar system. -- Python ≥ 3.8.0 - -And that's all! - -### Production environment +## Installation -Kosmorrolib is available [on PyPI](https://pypi.org/project/kosmorrolib/). To use it, invoke `pip install kosmorrolib`. +Take a look at [the official documentation](https://kosmorro.space/lib) for the information about how to install this library. ### Development environment To contribute to Kosmorrolib, you will need [Poetry](https://python-poetry.org), a software to manage the project from development to publishing. Clone this repository and run `poetry install` to install the dependencies. -And that's all, your development environment is ready for the fight! 👏 +And that's all, your development environment is ready! ## Documentation -All the documentation can be found [on the website](https://kosmorro.space/lib/doc). +You can find all the documentation of the library [on the website](https://kosmorro.space/lib/doc).