Skip to content

Commit 6a792e8

Browse files
authored
Add wgc missing endpoints (#12)
* Add PhaseAngle, PointingDirection, TangentPoint endpoints * Add not implemented error on Geometry Finder missing endpoints * Add __eq__ method to compare payload directly with a dict * Simplify and clean up payload tests * Bump API version * Expend invalid attribute tests on Calculation and fix doc strings * Update README * Update ReadTheDocs configuration * Fix python version in setup.py classifier
1 parent d5380fe commit 6a792e8

35 files changed

Lines changed: 2311 additions & 722 deletions

.readthedocs.yml

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
version: 2
22

33
build:
4-
image: latest
4+
os: ubuntu-24.04
5+
tools:
6+
python: "3.11"
57

68
python:
7-
version: 3.8
89
install:
9-
- requirements: docs/requirements.txt
10-
- method: pip
11-
path: .
10+
- requirements: docs/requirements.txt
11+
- method: pip
12+
path: .
1213

1314
sphinx:
1415
builder: html
1516
configuration: docs/conf.py
1617
fail_on_warning: true
18+
19+
formats:
20+
- pdf

README.rst

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Python package for NAIF WebGeoCalc API
2-
======================================
1+
🐍 Python package for NAIF WebGeoCalc API
2+
=========================================
33

44
|Docs| |Build| |Coverage| |CodeFactor|
55

@@ -47,8 +47,8 @@ calculations through this API.
4747
.. _Documentation: https://wgc2.jpl.nasa.gov:8443/webgeocalc/documents/api-info.html
4848
.. _`JavaScript examples`: https://wgc2.jpl.nasa.gov:8443/webgeocalc/example/perform-calculation.html
4949

50-
Note the user
51-
-------------
50+
⚠️ Caution
51+
----------
5252

5353
`WebGeoCalc`_ is not design to handle heavy calculation.
5454
If you need to make intensive queries, use `Spiceypy`_ or `SpiceMiner`_
@@ -59,17 +59,17 @@ Note the user
5959
.. _`SpiceMiner`: https://github.com/DaRasch/spiceminer
6060

6161

62-
Install
63-
-------
62+
📦 Install
63+
----------
6464
With ``pip``:
6565

6666
.. code:: bash
6767
6868
$ pip install webgeocalc
6969
7070
71-
Usage
72-
-----
71+
🚀 Usage
72+
--------
7373

7474
.. code:: python
7575
@@ -155,8 +155,9 @@ More details can be found in the `docs`_ and in the `Jupyter Notebooks`_.
155155
.. _`docs`: https://webgeocalc.readthedocs.io/en/stable/calculation.html
156156
.. _`Jupyter Notebooks`: https://nbviewer.jupyter.org/github/seignovert/python-webgeocalc/blob/main/examples/calculation.ipynb
157157

158-
Command Line Interface (cli)
159-
----------------------------
158+
159+
⚙️ Command Line Interface (cli)
160+
-------------------------------
160161

161162
The webgeocalc API can be call directly from the command line interface:
162163

@@ -212,8 +213,8 @@ More examples can be found in here_.
212213
.. _here: https://webgeocalc.readthedocs.io/en/stable/cli.html
213214

214215

215-
Local development and testing
216-
-----------------------------
216+
🧪 Local development and testing
217+
--------------------------------
217218

218219
Setup:
219220

@@ -244,7 +245,8 @@ Docs:
244245
sphinx-build docs docs/_build --color -W -bdoctest
245246
246247
247-
Disclaimer
248-
----------
248+
📣 Disclaimer
249+
-------------
250+
249251
This project is not supported or endorsed by either JPL, NAIF or NASA.
250252
The code is provided *"as is"*, use at your own risk.

docs/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ and can be retrieved directly as items:
3838
'WGC2 -- a WebGeocalc Server with enabled API at NAIF, JPL'
3939

4040
>>> API['version']
41-
'2.7.6'
41+
'2.8.2'
4242

4343

4444
Request kernel sets

0 commit comments

Comments
 (0)