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" 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).