| @@ -2,29 +2,21 @@ | |||||
| [](https://coveralls.io/github/Kosmorro/lib?branch=main) [](https://pypi.org/project/kosmorrolib) [](https://web.libera.chat/?nick=Astronaut?#kosmorro) | [](https://coveralls.io/github/Kosmorro/lib?branch=main) [](https://pypi.org/project/kosmorrolib) [](https://web.libera.chat/?nick=Astronaut?#kosmorro) | ||||
| [](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 | ### Development environment | ||||
| To contribute to Kosmorrolib, you will need [Poetry](https://python-poetry.org), a software to manage the project from development to publishing. | 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. | 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 | ## 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). | |||||