Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nwunderly committed Oct 17, 2020
1 parent 6b0cd93 commit 3ea1f9a
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 8 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -142,3 +142,4 @@ docs/crowdin.py
*.png
*.jpg
*.flac
rate_limit_torture_test.py
36 changes: 28 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,34 @@
# aio-nasa
An async python wrapper for NASA open APIs.
An async python wrapper for NASA open APIs. ([api.nasa.gov](https://api.nasa.gov/))

### Disclaimer:
This module is still in the testing phase.
#### Disclaimer
This module is still in the development/testing phase.
Bugs are still being worked out and breaking changes are common.

#### Current Progress: 1/17 APIs
- APOD: NASA Astronomy Picture of the Day
- API: **complete**
- CLI: **complete**
- Documentation: **needs work**
- InSight: Mars Weather Data
- API: **needs work**
- Exoplanet: NASA Exoplanet Database
- API: **incomplete**
- Asteroids-NeoWs: Near Earth Object Web Service
- API: **incomplete**

### Installing
aionasa can be installed directly from source with
aionasa can be installed directly from source with the command:
```
python3 -m pip install git+https://github.com/nwunderly/aio-nasa.git
# Linux
python3 -m pip install -U git+https://github.com/nwunderly/aio-nasa.git
# Windows
python -m pip install -U git+https://github.com/nwunderly/aio-nasa.git
```

### Python Example - APOD
This is a simple script that will return the title, explanation, and url from the most recent Astronomy Picture of the Day site,
This is a simple script that will return the title, explanation, and url from the most recent Astronomy Picture of the Day page,
then download and save the image.
```python
import asyncio
Expand All @@ -26,9 +43,12 @@ async def main():
asyncio.run(main())
```


### CLI Example - APOD
This command, like the above python script, will print data returned by the APOD API, then download and save the image.
```
python3 -m aionasa.apod --print --download .
```
```

#### Feedback
I'd love to hear any feedback on this project so far. It's early in development so the library's design is still being worked out.
Any design ideas or feature requests would be very helpful.

0 comments on commit 3ea1f9a

Please sign in to comment.