Browse Source

Merge branch 'main' into features

features
Jérôme Deuchnord 1 year ago
parent
commit
f21c14c45e
4 changed files with 10 additions and 18 deletions
  1. +1
    -1
      .github/workflows/prchecks.yml
  2. +1
    -1
      .github/workflows/release.yml
  3. +2
    -2
      .github/workflows/tests.yml
  4. +6
    -14
      README.md

+ 1
- 1
.github/workflows/prchecks.yml View File

@@ -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

+ 1
- 1
.github/workflows/release.yml View File

@@ -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


+ 2
- 2
.github/workflows/tests.yml View File

@@ -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"



+ 6
- 14
README.md View File

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

Loading…
Cancel
Save