More Python/pip package cleanup : version 2.0.17.

Generate astronomy.py directly in the package directory.
I realized it doesn't make sense to generate it in the
parent directory and then copy it; just generate it where
it will end up anyway.

Updated documentation so people know they can just do

    pip install astronomy-engine

to install Astronomy Engine in their Python project.

Removed the GitHub Actions status badge because it is redundant with
the checkmark/X indicator.

Now that private symbols are no longer exported, I had to
fix a couple of places where the unit tests still accessed them.
This commit is contained in:
Don Cross
2022-03-20 16:47:29 -04:00
parent 8963fb7b69
commit 74044b39d3
12 changed files with 55 additions and 19 deletions

View File

@@ -7,8 +7,22 @@ See the [home page](https://github.com/cosinekitty/astronomy) for more info.
---
## Quick Start
To include Astronomy Engine in your own Python program, all you need is
the file `astronomy.py` from this directory.
To include Astronomy Engine in your own Python program,
you can use the [astronomy-engine](https://pypi.org/project/astronomy-engine/) package:
```
pip install astronomy-engine
```
Alternatively, you can copy the file [astronomy/astronomy.py](astronomy/astronomy.py)
into your project directory.
With either approach, add the following line toward the top of your program:
```python
import astronomy
```
To get started quickly, here are some [examples](../../demo/python/).

View File

@@ -1 +0,0 @@
astronomy.py

View File

@@ -1,6 +1,5 @@
#!/bin/bash
rm -f dist/*
cp -v astronomy.py astronomy/astronomy.py || exit $?
python3 -m build || exit $?
python3 -m twine upload --repository astronomy-engine dist/* || exit $?
exit 0

View File

@@ -2,7 +2,7 @@ from setuptools import setup
setup(
name='astronomy-engine',
version='2.0.16',
version='2.0.17',
description='Astronomy calculation for Sun, Moon, and planets.',
long_description=open('README.md').read(),
long_description_content_type='text/markdown',