diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..5a31dd2 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog for Skyfield Data + +## 0.0.1 (2019-07-29) + +Initial release + +* This project includes minimal data files required by the [Python Skyfield library](https://rhodesmill.org/skyfield/): `de421.bsp`, `deltat.data`, `deltat.preds` and `Leap_Second.dat`, +* It provides a small Python script to download the files from their respective source, +* This script eventually checks if some of the files are expired and skips them (by default), +* Usage documentation is included in the `README.md` file. +* This project code is released under the terms of the MIT License. diff --git a/MANIFEST.in b/MANIFEST.in index 1615a35..0d3dbf1 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1,2 @@ recursive-include skyfield_data/data * +include COPYING diff --git a/Makefile b/Makefile index fd85d89..9614a96 100644 --- a/Makefile +++ b/Makefile @@ -13,4 +13,4 @@ clean: rm -f skyfield_data/data/* package: - python3 setup.py sdist + python3 setup.py sdist bdist_wheel diff --git a/README.md b/README.md index 939a115..641063d 100644 --- a/README.md +++ b/README.md @@ -22,13 +22,20 @@ Once all the files are on your disk space, you can instantiate your ``skyfield`` ## Usage -Once you have installed ``skyfield_data``, you may create a dedicated loader with the following code: +Install the packages using: + +```sh +pip install skyfield skyfield-data +``` + +To create a custom Skyfield loader, use the following code: ```python from skyfield_data import get_skyfield_data_path from skyfield.api import Loader load = Loader(get_skyfield_data_path()) -planets = load('de421.bsp') +planets = load('de421.bsp') # this command won't download this file +ts = load.timescale() # this command won't download the deltat + Leap Second files ``` ## Developers diff --git a/setup.cfg b/setup.cfg index f11093e..6e46d91 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = skyfield-data -version = 0.0.0 +version = 0.0.1 author = Bruno Bord author-email = bruno@jehaisleprintemps.net home-page = https://github.com/brunobord/skyfield-data